Welcome to the Kubernetes API. You can use the Kubernetes API to read and write Kubernetes resource objects via a Kubernetes API endpoint.
This is a high-level overview of the basic types of resources provide by the Kubernetes API and their primary functions.
Workloads are objects you use to manage and run your containers on the cluster.
Discovery & LB resources are objects you use to "stitch" your workloads together into an externally accessible, load-balanced Service.
Config & Storage resources are objects you use to inject initialization data into your applications, and to persist data that is external to your container.
Cluster resources objects define how the cluster itself is configured; these are typically used only by cluster operators.
Metadata resources are objects you use to configure the behavior of other resources within the cluster, such as HorizontalPodAutoscaler for scaling workloads.
Resource objects typically have 3 components:
Most resources provide the following Operations:
Create operations will create the resource in the storage backend. After a resource is create the system will apply the desired state.
Updates come in 2 forms: Replace and Patch:
ConfigMap or Secret resource will not result in all Pods seeing the changes unless the Pods are
restarted out of band.Reads come in 3 forms: Get, List and Watch:
Delete will delete a resource. Depending on the specific resource, child objects may or may not be garbage collected by the server. See notes on specific resource objects for details.
Resources may define additional operations specific to that resource type.
The API Groups and their versions are summarized in the following table.
| Group | Versions |
|---|---|
admissionregistration.k8s.io | v1, v1beta1 |
apiextensions.k8s.io | v1, v1beta1 |
apiregistration.k8s.io | v1, v1beta1 |
apps | v1 |
authentication.k8s.io | v1, v1beta1 |
authorization.k8s.io | v1, v1beta1 |
autoscaling | v1, v2beta2, v2beta1 |
batch | v1, v1beta1, v2alpha1 |
certificates.k8s.io | v1, v1beta1 |
coordination.k8s.io | v1, v1beta1 |
core | v1 |
discovery.k8s.io | v1beta1 |
events.k8s.io | v1, v1beta1 |
policy | v1beta1 |
extensions | v1beta1 |
flowcontrol.apiserver.k8s.io | v1beta1, v1alpha1 |
internal.apiserver.k8s.io | v1alpha1 |
networking.k8s.io | v1, v1beta1 |
node.k8s.io | v1, v1beta1, v1alpha1 |
rbac.authorization.k8s.io | v1, v1beta1, v1alpha1 |
scheduling.k8s.io | v1, v1beta1, v1alpha1 |
storage.k8s.io | v1, v1beta1, v1alpha1 |
Workloads resources are responsible for managing and running your containers on the cluster. Containers are created by Controllers through Pods. Pods run Containers and provide environmental dependencies such as shared or persistent storage Volumes and Configuration or Secret data injected into the container.
The most common Controllers are:
name: nginx
# Run the nginx:1.14 image
image: nginx:1.14
| Group | Version | Kind |
|---|---|---|
core | v1 | Container |
Warning:
Containers are only ever created within the context of a Pod. This is usually done using a Controller. See Controllers: Deployment, Job, or StatefulSet
| Field | Description |
|---|---|
argsstring array | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
commandstring array | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell |
envEnvVar array patch strategy: merge patch merge key: name | List of environment variables to set in the container. Cannot be updated. |
envFromEnvFromSource array | List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. |
imagestring | Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets. |
imagePullPolicystring | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images |
lifecycleLifecycle | Actions that the management system should take in response to container lifecycle events. Cannot be updated. |
livenessProbeProbe | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
namestring | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated. |
portsContainerPort array patch strategy: merge patch merge key: containerPort | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated. |
readinessProbeProbe | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
resourcesResourceRequirements | Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
securityContextSecurityContext | Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
startupProbeProbe | StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes |
stdinboolean | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false. |
stdinOnceboolean | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false |
terminationMessagePathstring | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated. |
terminationMessagePolicystring | Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated. |
ttyboolean | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false. |
volumeDevicesVolumeDevice array patch strategy: merge patch merge key: devicePath | volumeDevices is the list of block devices to be used by the container. |
volumeMountsVolumeMount array patch strategy: merge patch merge key: mountPath | Pod volumes to mount into the container's filesystem. Cannot be updated. |
workingDirstring | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated. |
| Field | Description |
|---|---|
containerIDstring | Container's ID in the format 'docker://<container_id>'. |
imagestring | The image the container is running. More info: https://kubernetes.io/docs/concepts/containers/images |
imageIDstring | ImageID of the container's image. |
lastStateContainerState | Details about the container's last termination condition. |
namestring | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated. |
readyboolean | Specifies whether the container has passed its readiness probe. |
restartCountinteger | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC. |
startedboolean | Specifies whether the container has passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets to false when the container is restarted, or if kubelet loses state temporarily. Is always true when no startupProbe is defined. |
stateContainerState | Details about the container's current condition. |
| Group | Version | Kind |
|---|---|---|
batch | v1beta1 | CronJob |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specCronJobSpec | Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusCronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
concurrencyPolicystring | Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one |
failedJobsHistoryLimitinteger | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
jobTemplateJobTemplateSpec | Specifies the job that will be created when executing a CronJob. |
schedulestring | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
startingDeadlineSecondsinteger | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
successfulJobsHistoryLimitinteger | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. Defaults to 3. |
suspendboolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |
| Field | Description |
|---|---|
activeObjectReference array | A list of pointers to currently running jobs. |
lastScheduleTimeTime | Information when was the last time the job was successfully scheduled. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCronJob array | items is the list of CronJobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CronJob
POST /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| 202 CronJob | Accepted |
partially update the specified CronJob
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace the specified CronJob
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
delete a CronJob
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CronJob
DELETE /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
list or watch objects of kind CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
list or watch objects of kind CronJob
GET /apis/batch/v1beta1/cronjobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v1beta1/watch/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v1beta1/watch/cronjobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CronJob
PATCH /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
read status of the specified CronJob
GET /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace status of the specified CronJob
PUT /apis/batch/v1beta1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
apiVersion: apps/v1
kind: DaemonSet
metadata:
# Unique key of the DaemonSet instance
name: daemonset-example
spec:
selector:
matchLabels:
app: daemonset-example
template:
metadata:
labels:
app: daemonset-example
spec:
containers:
# This container is run once on each Node in the cluster
- name: daemonset-example
image: ubuntu:trusty
command:
- /bin/sh
args:
- -c
# This script is run through `sh -c <script>`
- >-
while [ true ]; do
echo "DaemonSet running on $(hostname)" ;
sleep 10 ;
done
| Group | Version | Kind |
|---|---|---|
apps | v1 | DaemonSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specDaemonSetSpec | The desired behavior of this daemon set. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusDaemonSetStatus | The current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). |
revisionHistoryLimitinteger | The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
updateStrategyDaemonSetUpdateStrategy | An update strategy to replace existing DaemonSet pods with new pods. |
| Field | Description |
|---|---|
collisionCountinteger | Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
conditionsDaemonSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a DaemonSet's current state. |
currentNumberScheduledinteger | The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
desiredNumberScheduledinteger | The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberAvailableinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds) |
numberMisscheduledinteger | The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/ |
numberReadyinteger | The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready. |
numberUnavailableinteger | The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds) |
observedGenerationinteger | The most recent generation observed by the daemon set controller. |
updatedNumberScheduledinteger | The total number of nodes that are running updated daemon pod |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsDaemonSet array | A list of daemon sets. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| Field | Description |
|---|---|
maxUnavailable | The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0. Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update. |
kubectl command
$ echo 'apiVersion: apps/v1
kind: DaemonSet
metadata:
name: daemonset-example
spec:
selector:
matchLabels:
app: daemonset-example
template:
metadata:
labels:
app: daemonset-example
spec:
containers:
- name: daemonset-example
image: ubuntu:trusty
command:
- /bin/sh
args:
- -c
- >-
while [ true ]; do
echo "DaemonSet running on $(hostname)" ;
sleep 10 ;
done
' | kubectl create -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: apps/v1
kind: DaemonSet
metadata:
name: daemonset-example
spec:
selector:
matchLabels:
app: daemonset-example
template:
metadata:
labels:
app: daemonset-example
spec:
containers:
- name: daemonset-example
image: ubuntu:trusty
command:
- /bin/sh
args:
- -c
- >-
while [ true ]; do
echo "DaemonSet running on $(hostname)" ;
sleep 10 ;
done
' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets
daemonset "daemonset-example" created
{
"kind": "DaemonSet",
"apiVersion": "apps/v1",
"metadata": {
"name": "daemonset-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/daemonsets/daemonset-example",
"uid": "65552ced-b0e2-11e6-aef0-42010af00229",
"resourceVersion": "3558",
"generation": 1,
"creationTimestamp": "2016-11-22T18:35:09Z",
"labels": {
"app": "daemonset-example"
}
},
"spec": {
"selector": {
"matchLabels": {
"app": "daemonset-example"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "daemonset-example"
}
},
"spec": {
"containers": [
{
"name": "daemonset-example",
"image": "ubuntu:trusty",
"command": [
"/bin/sh"
],
"args": [
"-c",
"while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {
"currentNumberScheduled": 0,
"numberMisscheduled": 0,
"desiredNumberScheduled": 0
}
}
create a DaemonSet
POST /apis/apps/v1/namespaces/{namespace}/daemonsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
| 202 DaemonSet | Accepted |
partially update the specified DaemonSet
PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace the specified DaemonSet
PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
kubectl command
$ kubectl delete daemonset daemonset-example
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example'
daemonset "daemonset-example" deleted
{
"kind": "Status",
"apiVersion": "v1",
"metadata": {},
"status": "Success",
"code": 200
}
delete a DaemonSet
DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of DaemonSet
DELETE /apis/apps/v1/namespaces/{namespace}/daemonsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
$ kubectl get daemonset daemonset-example -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/daemonset-example
read the specified DaemonSet
GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
list or watch objects of kind DaemonSet
GET /apis/apps/v1/namespaces/{namespace}/daemonsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
list or watch objects of kind DaemonSet
GET /apis/apps/v1/daemonsets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 DaemonSetList | OK |
watch changes to an object of kind DaemonSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/namespaces/{namespace}/daemonsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of DaemonSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/daemonsets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified DaemonSet
PATCH /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
read status of the specified DaemonSet
GET /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
replace status of the specified DaemonSet
PUT /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the DaemonSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDaemonSet |
| Code | Description |
|---|---|
| 200 DaemonSet | OK |
| 201 DaemonSet | Created |
apiVersion: apps/v1
kind: Deployment
metadata:
# Unique key of the Deployment instance
name: deployment-example
spec:
# 3 Pods should exist at all times.
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
# Apply this label to pods and default
# the Deployment label selector to this value
app: nginx
spec:
containers:
- name: nginx
# Run this image
image: nginx:1.14
| Group | Version | Kind |
|---|---|---|
apps | v1 | Deployment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. |
specDeploymentSpec | Specification of the desired behavior of the Deployment. |
statusDeploymentStatus | Most recently observed status of the Deployment. |
| Field | Description |
|---|---|
minReadySecondsinteger | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
pausedboolean | Indicates that the deployment is paused. |
progressDeadlineSecondsinteger | The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status. Note that progress will not be estimated during the time a deployment is paused. Defaults to 600s. |
replicasinteger | Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1. |
revisionHistoryLimitinteger | The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10. |
selectorLabelSelector | Label selector for pods. Existing ReplicaSets whose pods are selected by this will be the ones affected by this deployment. It must match the pod template's labels. |
strategyDeploymentStrategy patch strategy: retainKeys | The deployment strategy to use to replace existing pods with new ones. |
templatePodTemplateSpec | Template describes the pods that will be created. |
| Field | Description |
|---|---|
availableReplicasinteger | Total number of available pods (ready for at least minReadySeconds) targeted by this deployment. |
collisionCountinteger | Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet. |
conditionsDeploymentCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a deployment's current state. |
observedGenerationinteger | The generation observed by the deployment controller. |
readyReplicasinteger | Total number of ready pods targeted by this deployment. |
replicasinteger | Total number of non-terminated pods targeted by this deployment (their labels match the selector). |
unavailableReplicasinteger | Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that are running but not yet available or pods that still have not been created. |
updatedReplicasinteger | Total number of non-terminated pods targeted by this deployment that have the desired template spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsDeployment array | Items is the list of Deployments. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
| Field | Description |
|---|---|
rollingUpdateRollingUpdateDeployment | Rolling update config params. Present only if DeploymentStrategyType = RollingUpdate. |
typestring | Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate. |
| Field | Description |
|---|---|
maxSurge | The maximum number of pods that can be scheduled above the desired number of pods. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up. Defaults to 25%. Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods. |
maxUnavailable | The maximum number of pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if MaxSurge is 0. Defaults to 25%. Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods. |
kubectl command
$ echo 'apiVersion: apps/v1
kind: Deployment
metadata:
name: deployment-example
spec:
replicas: 3
revisionHistoryLimit: 10
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14
ports:
- containerPort: 80
' | kubectl create -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: apps/v1
kind: Deployment
metadata:
name: deployment-example
spec:
replicas: 3
revisionHistoryLimit: 10
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.14
ports:
- containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
deployment "deployment-example" created
{
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
"resourceVersion": "2118306",
"generation": 1,
"creationTimestamp": "2016-10-28T01:53:19Z",
"labels": {
"app": "nginx"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
},
"revisionHistoryLimit": 10
},
"status": {}
}
create a Deployment
POST /apis/apps/v1/namespaces/{namespace}/deployments
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
| 202 Deployment | Accepted |
kubectl command
$ kubectl patch deployment deployment-example -p \
'{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}'
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}' \
'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
"deployment-example" patched
{
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "5dc3a8e6-b0ee-11e6-aef0-42010af00229",
"resourceVersion": "164489",
"generation": 11,
"creationTimestamp": "2016-11-22T20:00:50Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "5"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.16",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
},
"revisionHistoryLimit": 10
},
"status": {
"observedGeneration": 10,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
partially update the specified Deployment
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
$ echo 'apiVersion: apps/v1
kind: Deployment
metadata:
name: deployment-example
spec:
replicas: 3
revisionHistoryLimit: 10
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.16
ports:
- containerPort: 80
' | kubectl replace -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X PUT -H 'Content-Type: application/yaml' --data '
apiVersion: apps/v1
kind: Deployment
metadata:
name: deployment-example
spec:
replicas: 3
revisionHistoryLimit: 10
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx:1.16
ports:
- containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
deployment "deployment-example" replaced
{
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "4ccca349-9cb1-11e6-9c54-42010a800148",
"resourceVersion": "2119082",
"generation": 5,
"creationTimestamp": "2016-10-28T01:53:19Z",
"labels": {
"app": "nginx"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.16",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
},
"revisionHistoryLimit": 10
},
"status": {
"observedGeneration": 4,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
replace the specified Deployment
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
kubectl command
$ kubectl delete deployment deployment-example
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
deployment "deployment-example" deleted
{
"kind": "Status",
"apiVersion": "v1",
"metadata": {},
"status": "Success",
"code": 200
}
delete a Deployment
DELETE /apis/apps/v1/namespaces/{namespace}/deployments/{name}
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Deployment
DELETE /apis/apps/v1/namespaces/{namespace}/deployments
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
$ kubectl get deployment deployment-example -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
{
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "1b33145a-9c63-11e6-9c54-42010a800148",
"resourceVersion": "2064726",
"generation": 4,
"creationTimestamp": "2016-10-27T16:33:35Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "1"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 4,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
{
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "1b33145a-9c63-11e6-9c54-42010a800148",
"resourceVersion": "2064726",
"generation": 4,
"creationTimestamp": "2016-10-27T16:33:35Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "1"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 4,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
read the specified Deployment
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
kubectl command
$ kubectl get deployment -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments'
{
"kind": "List",
"apiVersion": "v1",
"metadata": {},
"items": [
{
"kind": "Deployment",
"apiVersion": "app/v1beta1",
"metadata": {
"name": "docs",
"namespace": "default",
"selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
"uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
"resourceVersion": "1924126",
"generation": 21,
"creationTimestamp": "2016-10-13T16:06:00Z",
"labels": {
"run": "docs"
},
"annotations": {
"deployment.kubernetes.io/revision": "10",
"replicatingperfection.net/push-image": "true"
}
},
"spec": {
"replicas": 1,
"selector": {
"matchLabels": {
"run": "docs"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"auto-pushed-image-pwittrock/api-docs": "1477496453",
"run": "docs"
}
},
"spec": {
"containers": [
{
"name": "docs",
"image": "pwittrock/api-docs:v9",
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 21,
"replicas": 1,
"updatedReplicas": 1,
"availableReplicas": 1
}
},
{
"kind": "Deployment",
"apiVersion": "app/v1beta1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
"uid": "1b33145a-9c63-11e6-9c54-42010a800148",
"resourceVersion": "2064726",
"generation": 4,
"creationTimestamp": "2016-10-27T16:33:35Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "1"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 4,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
]
}
{
"kind": "List",
"apiVersion": "v1",
"metadata": {},
"items": [
{
"kind": "Deployment",
"apiVersion": "app/v1beta1",
"metadata": {
"name": "docs",
"namespace": "default",
"selfLink": "/apis/app/v1beta1/namespaces/default/deployments/docs",
"uid": "ef49e1d2-915e-11e6-be81-42010a80003f",
"resourceVersion": "1924126",
"generation": 21,
"creationTimestamp": "2016-10-13T16:06:00Z",
"labels": {
"run": "docs"
},
"annotations": {
"deployment.kubernetes.io/revision": "10",
"replicatingperfection.net/push-image": "true"
}
},
"spec": {
"replicas": 1,
"selector": {
"matchLabels": {
"run": "docs"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"auto-pushed-image-pwittrock/api-docs": "1477496453",
"run": "docs"
}
},
"spec": {
"containers": [
{
"name": "docs",
"image": "pwittrock/api-docs:v9",
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 21,
"replicas": 1,
"updatedReplicas": 1,
"availableReplicas": 1
}
},
{
"kind": "Deployment",
"apiVersion": "app/v1beta1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/app/v1beta1/namespaces/default/deployments/deployment-example",
"uid": "1b33145a-9c63-11e6-9c54-42010a800148",
"resourceVersion": "2064726",
"generation": 4,
"creationTimestamp": "2016-10-27T16:33:35Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "1"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 4,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
]
}
list or watch objects of kind Deployment
GET /apis/apps/v1/namespaces/{namespace}/deployments
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
list or watch objects of kind Deployment
GET /apis/apps/v1/deployments
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 DeploymentList | OK |
kubectl command
$ kubectl get deployment deployment-example --watch -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deployments/deployment-example'
{
"type": "ADDED",
"object": {
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "64c12290-9cbf-11e6-9c54-42010a800148",
"resourceVersion": "2128095",
"generation": 2,
"creationTimestamp": "2016-10-28T03:34:12Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "3"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {
},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {
}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 2,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
}
{
"type": "ADDED",
"object": {
"kind": "Deployment",
"apiVersion": "apps/v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/apis/apps/v1/namespaces/default/deployments/deployment-example",
"uid": "64c12290-9cbf-11e6-9c54-42010a800148",
"resourceVersion": "2128095",
"generation": 2,
"creationTimestamp": "2016-10-28T03:34:12Z",
"labels": {
"app": "nginx"
},
"annotations": {
"deployment.kubernetes.io/revision": "3"
}
},
"spec": {
"replicas": 3,
"selector": {
"matchLabels": {
"app": "nginx"
}
},
"template": {
"metadata": {
"creationTimestamp": null,
"labels": {
"app": "nginx"
}
},
"spec": {
"containers": [
{
"name": "nginx",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
"protocol": "TCP"
}
],
"resources": {
},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "IfNotPresent"
}
],
"restartPolicy": "Always",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {
}
}
},
"strategy": {
"type": "RollingUpdate",
"rollingUpdate": {
"maxUnavailable": 1,
"maxSurge": 1
}
}
},
"status": {
"observedGeneration": 2,
"replicas": 3,
"updatedReplicas": 3,
"availableReplicas": 3
}
}
}
watch changes to an object of kind Deployment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apps/v1/watch/namespaces/{namespace}/deployments/{name}
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/namespaces/{namespace}/deployments
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Deployment. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/deployments
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Deployment
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Deployment | OK |
read status of the specified Deployment
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Deployment | OK |
replace status of the specified Deployment
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/status
| Parameter | Description |
|---|---|
name | name of the Deployment |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyDeployment |
| Code | Description |
|---|---|
| 200 Deployment | OK |
| 201 Deployment | Created |
read scale of the specified Deployment
GET /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified Deployment
PUT /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified Deployment
PATCH /apis/apps/v1/namespaces/{namespace}/deployments/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
apiVersion: batch/v1
kind: Job
metadata:
# Unique key of the Job instance
name: example-job
spec:
template:
metadata:
name: example-job
spec:
containers:
- name: pi
image: perl
command: ["perl"]
args: ["-Mbignum=bpi", "-wle", "print bpi(2000)"]
# Do not restart containers after they exit
restartPolicy: Never
| Group | Version | Kind |
|---|---|---|
batch | v1 | Job |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specJobSpec | Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusJobStatus | Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
activeDeadlineSecondsinteger | Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer |
backoffLimitinteger | Specifies the number of retries before marking this job failed. Defaults to 6 |
completionsinteger | Specifies the desired number of successfully finished pods the job should be run with. Setting to nil means that the success of any pod signals the success of all pods, and allows parallelism to have any positive value. Setting to 1 means that parallelism is limited to 1 and the success of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
manualSelectorboolean | manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this job and appends those labels to the pod template. When true, the user is responsible for picking unique labels and specifying the selector. Failure to pick a unique label may cause this and other jobs to not function correctly. However, You may see `manualSelector=true` in jobs that were created with the old `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector |
parallelisminteger | Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
selectorLabelSelector | A label query over pods that should match the pod count. Normally, the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Describes the pod that will be created when executing a job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
ttlSecondsAfterFinishedinteger | ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is unset, the Job won't be automatically deleted. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature. |
| Field | Description |
|---|---|
activeinteger | The number of actively running pods. |
completionTimeTime | Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is only set when the job finishes successfully. |
conditionsJobCondition array patch strategy: merge patch merge key: type | The latest available observations of an object's current state. When a job fails, one of the conditions will have type == "Failed". More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/ |
failedinteger | The number of pods which reached phase Failed. |
startTimeTime | Represents time when the job was acknowledged by the job controller. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. |
succeededinteger | The number of pods which reached phase Succeeded. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsJob array | items is the list of Jobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
kubectl command
$ echo 'apiVersion: batch/v1
kind: Job
metadata:
name: example-job
spec:
template:
metadata:
name: example-job
spec:
containers:
- name: pi
image: perl
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
' | kubectl create -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
apiVersion: batch/v1
kind: Job
metadata:
name: example-job
spec:
template:
metadata:
name: example-job
spec:
containers:
- name: pi
image: perl
command: ["perl", "-Mbignum=bpi", "-wle", "print bpi(2000)"]
restartPolicy: Never
' http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs
job "example-job" created
{
"kind": "Job",
"apiVersion": "batch/v1",
"metadata": {
"name": "example-job",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7479",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "example-job",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": "example-job"
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {}
}
create a Job
POST /apis/batch/v1/namespaces/{namespace}/jobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 200 Job | OK |
| 201 Job | Created |
| 202 Job | Accepted |
partially update the specified Job
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Job | OK |
replace the specified Job
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 200 Job | OK |
| 201 Job | Created |
kubectl command
$ kubectl delete job example-job
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job'
job "example-job" deleted
{
"kind": "Status",
"apiVersion": "v1",
"metadata": {},
"status": "Success",
"code": 200
}
delete a Job
DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Job
DELETE /apis/batch/v1/namespaces/{namespace}/jobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
kubectl command
$ kubectl get job example-job -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs/example-job
{
"kind": "Job",
"apiVersion": "batch/v1",
"metadata": {
"name": "example-job",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "example-job",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": "example-job"
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
{
"kind": "Job",
"apiVersion": "batch/v1",
"metadata": {
"name": "example-job",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "example-job",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": "example-job"
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
read the specified Job
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Job | OK |
kubectl command
$ kubectl get job -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/namespaces/default/jobs'
{
"kind": "JobList",
"apiVersion": "batch/v1",
"metadata": {
"selfLink": "/apis/batch/v1/namespaces/default/jobs",
"resourceVersion": "7589"
},
"items": [
{
"metadata": {
"name": "",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": ""
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
]
}
{
"kind": "JobList",
"apiVersion": "batch/v1",
"metadata": {
"selfLink": "/apis/batch/v1/namespaces/default/jobs",
"resourceVersion": "7589"
},
"items": [
{
"metadata": {
"name": "",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": ""
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
]
}
list or watch objects of kind Job
GET /apis/batch/v1/namespaces/{namespace}/jobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 JobList | OK |
list or watch objects of kind Job
GET /apis/batch/v1/jobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 JobList | OK |
kubectl command
$ kubectl get job example-job --watch -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs/example-job'
{
"type": "ADDED",
"object": {
"kind": "Job",
"apiVersion": "batch/v1",
"metadata": {
"name": "example-job",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "example-job",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": "example-job"
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {
},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {
}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
}
{
"type": "ADDED",
"object": {
"kind": "Job",
"apiVersion": "batch/v1",
"metadata": {
"name": "example-job",
"namespace": "default",
"selfLink": "/apis/batch/v1/namespaces/default/jobs/example-job",
"uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"resourceVersion": "7482",
"creationTimestamp": "2016-11-04T18:45:25Z"
},
"spec": {
"parallelism": 1,
"completions": 1,
"selector": {
"matchLabels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7"
}
},
"template": {
"metadata": {
"name": "example-job",
"creationTimestamp": null,
"labels": {
"controller-uid": "d93a3569-a2be-11e6-a008-fa043d458cc7",
"job-name": "example-job"
}
},
"spec": {
"containers": [
{
"name": "pi",
"image": "perl",
"command": [
"perl",
"-Mbignum=bpi",
"-wle",
"print bpi(2000)"
],
"resources": {
},
"terminationMessagePath": "/dev/termination-log",
"imagePullPolicy": "Always"
}
],
"restartPolicy": "Never",
"terminationGracePeriodSeconds": 30,
"dnsPolicy": "ClusterFirst",
"securityContext": {
}
}
}
},
"status": {
"startTime": "2016-11-04T18:45:25Z",
"active": 1
}
}
}
watch changes to an object of kind Job. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v1/watch/namespaces/{namespace}/jobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Job. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v1/watch/jobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Job
PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Job | OK |
read status of the specified Job
GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Job | OK |
replace status of the specified Job
PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the Job |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyJob |
| Code | Description |
|---|---|
| 200 Job | OK |
| 201 Job | Created |
apiVersion: v1
kind: Pod
metadata:
name: pod-example
spec:
containers:
- name: ubuntu
image: ubuntu:trusty
command: ["echo"]
args: ["Hello World"]
| Group | Version | Kind |
|---|---|---|
core | v1 | Pod |
Warning:
It is recommended that users create Pods only through a Controller, and not directly. See Controllers: Deployment, Job, or StatefulSet.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusPodStatus | Most recently observed status of the pod. This data may not be up to date. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
activeDeadlineSecondsinteger | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. |
affinityAffinity | If specified, the pod's scheduling constraints |
automountServiceAccountTokenboolean | AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. |
containersContainer array patch strategy: merge patch merge key: name | List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated. |
dnsConfigPodDNSConfig | Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy. |
dnsPolicystring | Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. To have DNS options set along with hostNetwork, you have to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. |
enableServiceLinksboolean | EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true. |
ephemeralContainersEphemeralContainer array patch strategy: merge patch merge key: name | List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a pod, and it cannot be modified by updating the pod spec. In order to add an ephemeral container to an existing pod, use the pod's ephemeralcontainers subresource. This field is alpha-level and is only honored by servers that enable the EphemeralContainers feature. |
hostAliasesHostAlias array patch strategy: merge patch merge key: ip | HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods. |
hostIPCboolean | Use the host's ipc namespace. Optional: Default to false. |
hostNetworkboolean | Host networking requested for this pod. Use the host's network namespace. If this option is set, the ports that will be used must be specified. Default to false. |
hostPIDboolean | Use the host's pid namespace. Optional: Default to false. |
hostnamestring | Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value. |
imagePullSecretsLocalObjectReference array patch strategy: merge patch merge key: name | ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
initContainersContainer array patch strategy: merge patch merge key: name | List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
nodeNamestring | NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements. |
nodeSelectorobject | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
overheadobject | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature. |
preemptionPolicystring | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
priorityinteger | The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. |
priorityClassNamestring | If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. |
readinessGatesPodReadinessGate array | If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to "True" More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md |
restartPolicystring | Restart policy for all containers within the pod. One of Always, OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy |
runtimeClassNamestring | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md This is a beta feature as of Kubernetes v1.14. |
schedulerNamestring | If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler. |
securityContextPodSecurityContext | SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty. See type description for default values of each field. |
serviceAccountstring | DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead. |
serviceAccountNamestring | ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
setHostnameAsFQDNboolean | If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect. Default to false. |
shareProcessNamespaceboolean | Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first process in each container will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both be set. Optional: Default to false. |
subdomainstring | If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod namespace>.svc.<cluster domain>". If not specified, the pod will not have a domainname at all. |
terminationGracePeriodSecondsinteger | Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. |
tolerationsToleration array | If specified, the pod's tolerations. |
topologySpreadConstraintsTopologySpreadConstraint array patch strategy: merge patch merge key: topologyKey | TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints are ANDed. |
volumesVolume array patch strategy: merge,retainKeys patch merge key: name | List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes |
| Field | Description |
|---|---|
conditionsPodCondition array patch strategy: merge patch merge key: type | Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions |
containerStatusesContainerStatus array | The list has one entry per container in the manifest. Each entry is currently the output of `docker inspect`. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
ephemeralContainerStatusesContainerStatus array | Status for any ephemeral containers that have run in this pod. This field is alpha-level and is only populated by servers that enable the EphemeralContainers feature. |
hostIPstring | IP address of the host to which the pod is assigned. Empty if not yet scheduled. |
initContainerStatusesContainerStatus array | The list has one entry per init container in the manifest. The most recent successful init container will have ready = true, the most recently started container will have startTime set. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status |
messagestring | A human readable message indicating details about why the pod is in this condition. |
nominatedNodeNamestring | nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to give the resources on this node to a higher priority pod that is created after preemption. As a result, this field may be different than PodSpec.nodeName when the pod is scheduled. |
phasestring | The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more detail about the pod's status. There are five possible phase values: Pending: The pod has been accepted by the Kubernetes system, but one or more of the container images has not been created. This includes time before being scheduled as well as time spent downloading images over the network, which could take a while. Running: The pod has been bound to a node, and all of the containers have been created. At least one container is still running, or is in the process of starting or restarting. Succeeded: All containers in the pod have terminated in success, and will not be restarted. Failed: All containers in the pod have terminated, and at least one container has terminated in failure. The container either exited with non-zero status or was terminated by the system. Unknown: For some reason the state of the pod could not be obtained, typically due to an error in communicating with the host of the pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase |
podIPstring | IP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated. |
podIPsPodIP array patch strategy: merge patch merge key: ip | podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is empty if no IPs have been allocated yet. |
qosClassstring | The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md |
reasonstring | A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted' |
startTimeTime | RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPod array | List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a Pod
POST /api/v1/namespaces/{namespace}/pods
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 201 Pod | Created |
| 202 Pod | Accepted |
create eviction of a Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/eviction
| Parameter | Description |
|---|---|
name | name of the Eviction |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyEviction |
| Code | Description |
|---|---|
| 200 Eviction | OK |
| 201 Eviction | Created |
| 202 Eviction | Accepted |
partially update the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Pod | OK |
replace the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 201 Pod | Created |
delete a Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 202 Pod | Accepted |
delete collection of Pod
DELETE /api/v1/namespaces/{namespace}/pods
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Pod | OK |
list or watch objects of kind Pod
GET /api/v1/namespaces/{namespace}/pods
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodList | OK |
list or watch objects of kind Pod
GET /api/v1/pods
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodList | OK |
watch changes to an object of kind Pod. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/pods/{name}
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/pods
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Pod. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/pods
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Pod
PATCH /api/v1/namespaces/{namespace}/pods/{name}/status
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Pod | OK |
read status of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/status
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Pod | OK |
replace status of the specified Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/status
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPod |
| Code | Description |
|---|---|
| 200 Pod | OK |
| 201 Pod | Created |
connect POST requests to portforward of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/portforward
| Parameter | Description |
|---|---|
name | name of the PodPortForwardOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
ports | List of ports to forward Required when using WebSockets |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Pod
POST /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Pod
DELETE /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to portforward of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/portforward
| Parameter | Description |
|---|---|
name | name of the PodPortForwardOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
ports | List of ports to forward Required when using WebSockets |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Pod
HEAD /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Pod
PUT /api/v1/namespaces/{namespace}/pods/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the PodProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to pod. |
| Code | Description |
|---|---|
| 200 string | OK |
read log of the specified Pod
GET /api/v1/namespaces/{namespace}/pods/{name}/log
| Parameter | Description |
|---|---|
name | name of the Pod |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
container | The container for which to stream logs. Defaults to only container if there is one container in the pod. |
follow | Follow the log stream of the pod. Defaults to false. |
insecureSkipTLSVerifyBackend | insecureSkipTLSVerifyBackend indicates that the apiserver should not confirm the validity of the serving certificate of the backend it is connecting to. This will make the HTTPS connection between the apiserver and the backend insecure. This means the apiserver cannot verify the log data it is receiving came from the real kubelet. If the kubelet is configured to verify the apiserver's TLS credentials, it does not mean the connection to the real kubelet is vulnerable to a man in the middle attack (e.g. an attacker could not intercept the actual log data coming from the real kubelet). |
limitBytes | If set, the number of bytes to read from the server before terminating the log output. This may not display a complete final line of logging, and may return slightly more or slightly less than the specified limit. |
pretty | If 'true', then the output is pretty printed. |
previous | Return previous terminated container logs. Defaults to false. |
sinceSeconds | A relative time in seconds before the current time from which to show logs. If this value precedes the time a pod was started, only logs since the pod start will be returned. If this value is in the future, no logs will be returned. Only one of sinceSeconds or sinceTime may be specified. |
tailLines | If set, the number of lines from the end of the logs to show. If not specified, logs are shown from the creation of the container or sinceSeconds or sinceTime |
timestamps | If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line of log output. Defaults to false. |
| Code | Description |
|---|---|
| 200 string | OK |
apiVersion: apps/v1
kind: ReplicaSet
metadata:
# Unique key of the ReplicaSet instance
name: replicaset-example
spec:
# 3 Pods should exist at all times.
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.14
| Group | Version | Kind |
|---|---|---|
apps | v1 | ReplicaSet |
Warning:
In many cases it is recommended to create a Deployment instead of ReplicaSet.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicaSet are empty, they are defaulted to be the same as the Pod(s) that the ReplicaSet manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specReplicaSetSpec | Spec defines the specification of the desired behavior of the ReplicaSet. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusReplicaSetStatus | Status is the most recently observed status of the ReplicaSet. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
selectorLabelSelector | Selector is a label query over pods that should match the replica count. Label keys and values that must match in order to be controlled by this replica set. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replica set. |
conditionsReplicaSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replica set's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replicaset. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed ReplicaSet. |
readyReplicasinteger | The number of ready replicas for this replica set. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller/#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsReplicaSet array | List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ReplicaSet
POST /apis/apps/v1/namespaces/{namespace}/replicasets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
| 202 ReplicaSet | Accepted |
partially update the specified ReplicaSet
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace the specified ReplicaSet
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
delete a ReplicaSet
DELETE /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicaSet
DELETE /apis/apps/v1/namespaces/{namespace}/replicasets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicaSet
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
list or watch objects of kind ReplicaSet
GET /apis/apps/v1/namespaces/{namespace}/replicasets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
list or watch objects of kind ReplicaSet
GET /apis/apps/v1/replicasets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ReplicaSetList | OK |
watch changes to an object of kind ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/namespaces/{namespace}/replicasets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicaSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/replicasets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicaSet
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
read status of the specified ReplicaSet
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
replace status of the specified ReplicaSet
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicaSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicaSet |
| Code | Description |
|---|---|
| 200 ReplicaSet | OK |
| 201 ReplicaSet | Created |
read scale of the specified ReplicaSet
GET /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicaSet
PUT /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified ReplicaSet
PATCH /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
apiVersion: v1
kind: ReplicationController
metadata:
# Unique key of the ReplicationController instance
name: replicationcontroller-example
spec:
# 3 Pods should exist at all times.
replicas: 3
template:
metadata:
labels:
app: nginx
spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.14
| Group | Version | Kind |
|---|---|---|
core | v1 | ReplicationController |
Warning:
In many cases it is recommended to create a Deployment instead of a ReplicationController.
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | If the Labels of a ReplicationController are empty, they are defaulted to be the same as the Pod(s) that the replication controller manages. Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specReplicationControllerSpec | Spec defines the specification of the desired behavior of the replication controller. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusReplicationControllerStatus | Status is the most recently observed status of the replication controller. This data may be out of date by some window of time. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
minReadySecondsinteger | Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready) |
replicasinteger | Replicas is the number of desired replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
selectorobject | Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in order to be controlled by this replication controller, if empty defaulted to labels on Pod template. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
templatePodTemplateSpec | Template is the object that describes the pod that will be created if insufficient replicas are detected. This takes precedence over a TemplateRef. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template |
| Field | Description |
|---|---|
availableReplicasinteger | The number of available replicas (ready for at least minReadySeconds) for this replication controller. |
conditionsReplicationControllerCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a replication controller's current state. |
fullyLabeledReplicasinteger | The number of pods that have labels matching the labels of the pod template of the replication controller. |
observedGenerationinteger | ObservedGeneration reflects the generation of the most recently observed replication controller. |
readyReplicasinteger | The number of ready replicas for this replication controller. |
replicasinteger | Replicas is the most recently oberved number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsReplicationController array | List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ReplicationController
POST /api/v1/namespaces/{namespace}/replicationcontrollers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
| 202 ReplicationController | Accepted |
partially update the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
replace the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
delete a ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ReplicationController
DELETE /api/v1/namespaces/{namespace}/replicationcontrollers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
list or watch objects of kind ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ReplicationControllerList | OK |
list or watch objects of kind ReplicationController
GET /api/v1/replicationcontrollers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ReplicationControllerList | OK |
watch changes to an object of kind ReplicationController. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers/{name}
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/replicationcontrollers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ReplicationController. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/replicationcontrollers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
read status of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
replace status of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/status
| Parameter | Description |
|---|---|
name | name of the ReplicationController |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyReplicationController |
| Code | Description |
|---|---|
| 200 ReplicationController | OK |
| 201 ReplicationController | Created |
read scale of the specified ReplicationController
GET /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified ReplicationController
PUT /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified ReplicationController
PATCH /api/v1/namespaces/{namespace}/replicationcontrollers/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
| Group | Version | Kind |
|---|---|---|
apps | v1 | StatefulSet |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specStatefulSetSpec | Spec defines the desired identities of pods in this set. |
statusStatefulSetStatus | Status is the current status of Pods in this StatefulSet. This data may be out of date by some window of time. |
| Field | Description |
|---|---|
podManagementPolicystring | podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. |
replicasinteger | replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent identity. If unspecified, defaults to 1. |
revisionHistoryLimitinteger | revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently applied StatefulSetSpec version. The default value is 10. |
selectorLabelSelector | selector is a label query over pods that should match the replica count. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
serviceNamestring | serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames that follow the pattern: pod-specific-string.serviceName.default.svc.cluster.local where "pod-specific-string" is managed by the StatefulSet controller. |
templatePodTemplateSpec | template is the object that describes the pod that will be created if insufficient replicas are detected. Each pod stamped out by the StatefulSet will fulfill this Template, but have a unique identity from the rest of the StatefulSet. |
updateStrategyStatefulSetUpdateStrategy | updateStrategy indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template. |
volumeClaimTemplatesPersistentVolumeClaim array | volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of a pod. Every claim in this list must have at least one matching (by name) volumeMount in one container in the template. A claim in this list takes precedence over any volumes in the template, with the same name. |
| Field | Description |
|---|---|
collisionCountinteger | collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision. |
conditionsStatefulSetCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a statefulset's current state. |
currentReplicasinteger | currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision. |
currentRevisionstring | currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas). |
observedGenerationinteger | observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server. |
readyReplicasinteger | readyReplicas is the number of Pods created by the StatefulSet controller that have a Ready Condition. |
replicasinteger | replicas is the number of Pods created by the StatefulSet controller. |
updateRevisionstring | updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas) |
updatedReplicasinteger | updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsStatefulSet array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a StatefulSet
POST /apis/apps/v1/namespaces/{namespace}/statefulsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
| 202 StatefulSet | Accepted |
partially update the specified StatefulSet
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace the specified StatefulSet
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
delete a StatefulSet
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StatefulSet
DELETE /apis/apps/v1/namespaces/{namespace}/statefulsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StatefulSet
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
list or watch objects of kind StatefulSet
GET /apis/apps/v1/namespaces/{namespace}/statefulsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
list or watch objects of kind StatefulSet
GET /apis/apps/v1/statefulsets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 StatefulSetList | OK |
watch changes to an object of kind StatefulSet. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets/{name}
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/namespaces/{namespace}/statefulsets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StatefulSet. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/statefulsets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified StatefulSet
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
read status of the specified StatefulSet
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
replace status of the specified StatefulSet
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/status
| Parameter | Description |
|---|---|
name | name of the StatefulSet |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStatefulSet |
| Code | Description |
|---|---|
| 200 StatefulSet | OK |
| 201 StatefulSet | Created |
read scale of the specified StatefulSet
GET /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Scale | OK |
replace scale of the specified StatefulSet
PUT /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyScale |
| Code | Description |
|---|---|
| 200 Scale | OK |
| 201 Scale | Created |
partially update scale of the specified StatefulSet
PATCH /apis/apps/v1/namespaces/{namespace}/statefulsets/{name}/scale
| Parameter | Description |
|---|---|
name | name of the Scale |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Scale | OK |
Service API resources are responsible for stitching your workloads together into an accessible Loadbalanced Service. By default,
Workloads are only accessible within the cluster, and they must be exposed externally using a either
a *LoadBalancer* or *NodePort* Service. For development, internally accessible
Workloads can be accessed via proxy through the api master using the kubectl proxy command.
Common resource types:
| Group | Version | Kind |
|---|---|---|
core | v1 | Endpoints |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
subsetsEndpointSubset array | The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of which are not (because they come from different containers) will result in the address being displayed in different subsets for the different ports. No address will appear in both Addresses and NotReadyAddresses in the same subset. Sets of addresses and ports that comprise a service. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsEndpoints array | List of endpoints. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create Endpoints
POST /api/v1/namespaces/{namespace}/endpoints
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEndpoints |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
| 201 Endpoints | Created |
| 202 Endpoints | Accepted |
partially update the specified Endpoints
PATCH /api/v1/namespaces/{namespace}/endpoints/{name}
| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
replace the specified Endpoints
PUT /api/v1/namespaces/{namespace}/endpoints/{name}
| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEndpoints |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
| 201 Endpoints | Created |
delete Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints/{name}
| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Endpoints
DELETE /api/v1/namespaces/{namespace}/endpoints
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Endpoints
GET /api/v1/namespaces/{namespace}/endpoints/{name}
| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Endpoints | OK |
list or watch objects of kind Endpoints
GET /api/v1/namespaces/{namespace}/endpoints
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EndpointsList | OK |
list or watch objects of kind Endpoints
GET /api/v1/endpoints
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EndpointsList | OK |
watch changes to an object of kind Endpoints. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/endpoints/{name}
| Parameter | Description |
|---|---|
name | name of the Endpoints |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/endpoints
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Endpoints. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/endpoints
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
discovery.k8s.io | v1beta1 | EndpointSlice |
| Field | Description |
|---|---|
addressTypestring | addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are currently supported: * IPv4: Represents an IPv4 Address. * IPv6: Represents an IPv6 Address. * FQDN: Represents a Fully Qualified Domain Name. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
endpointsEndpoint array | endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
portsEndpointPort array | ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. When ports is empty, it indicates that there are no defined ports. When a port is defined with a nil port value, it indicates "all ports". Each slice may include a maximum of 100 ports. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsEndpointSlice array | List of endpoint slices |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
create an EndpointSlice
POST /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEndpointSlice |
| Code | Description |
|---|---|
| 200 EndpointSlice | OK |
| 201 EndpointSlice | Created |
| 202 EndpointSlice | Accepted |
partially update the specified EndpointSlice
PATCH /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
| Parameter | Description |
|---|---|
name | name of the EndpointSlice |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 EndpointSlice | OK |
replace the specified EndpointSlice
PUT /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
| Parameter | Description |
|---|---|
name | name of the EndpointSlice |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEndpointSlice |
| Code | Description |
|---|---|
| 200 EndpointSlice | OK |
| 201 EndpointSlice | Created |
delete an EndpointSlice
DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
| Parameter | Description |
|---|---|
name | name of the EndpointSlice |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of EndpointSlice
DELETE /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified EndpointSlice
GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices/{name}
| Parameter | Description |
|---|---|
name | name of the EndpointSlice |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 EndpointSlice | OK |
list or watch objects of kind EndpointSlice
GET /apis/discovery.k8s.io/v1beta1/namespaces/{namespace}/endpointslices
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EndpointSliceList | OK |
list or watch objects of kind EndpointSlice
GET /apis/discovery.k8s.io/v1beta1/endpointslices
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EndpointSliceList | OK |
watch changes to an object of kind EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices/{name}
| Parameter | Description |
|---|---|
name | name of the EndpointSlice |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/discovery.k8s.io/v1beta1/watch/namespaces/{namespace}/endpointslices
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of EndpointSlice. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/discovery.k8s.io/v1beta1/watch/endpointslices
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | Ingress |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specIngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusIngressStatus | Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
defaultBackendIngressBackend | DefaultBackend is the backend that should handle requests that don't match any rule. If Rules are not specified, DefaultBackend must be specified. If DefaultBackend is not set, the handling of requests that do not match any of the rules will be up to the Ingress controller. |
ingressClassNamestring | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. |
rulesIngressRule array | A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
tlsIngressTLS array | TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
| Field | Description |
|---|---|
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsIngress array | Items is the list of Ingress. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create an Ingress
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| 202 Ingress | Accepted |
partially update the specified Ingress
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace the specified Ingress
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
delete an Ingress
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Ingress
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Ingress
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
list or watch objects of kind Ingress
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
list or watch objects of kind Ingress
GET /apis/networking.k8s.io/v1/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1/watch/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Ingress
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
read status of the specified Ingress
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace status of the specified Ingress
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | IngressClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specIngressClassSpec | Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
controllerstring | Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. |
parametersTypedLocalObjectReference | Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsIngressClass array | Items is the list of IngressClasses. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
create an IngressClass
POST /apis/networking.k8s.io/v1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngressClass |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
| 201 IngressClass | Created |
| 202 IngressClass | Accepted |
partially update the specified IngressClass
PATCH /apis/networking.k8s.io/v1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
replace the specified IngressClass
PUT /apis/networking.k8s.io/v1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngressClass |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
| 201 IngressClass | Created |
delete an IngressClass
DELETE /apis/networking.k8s.io/v1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of IngressClass
DELETE /apis/networking.k8s.io/v1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified IngressClass
GET /apis/networking.k8s.io/v1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
list or watch objects of kind IngressClass
GET /apis/networking.k8s.io/v1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressClassList | OK |
watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/networking.k8s.io/v1/watch/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1/watch/ingressclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
kind: Service
apiVersion: v1
metadata:
# Unique key of the Service instance
name: service-example
spec:
ports:
# Accept traffic sent to port 80
- name: http
port: 80
targetPort: 80
selector:
# Loadbalance traffic across Pods matching
# this label selector
app: nginx
# Create an HA proxy in the cloud provider
# with an External IP address - *Only supported
# by some cloud providers*
type: LoadBalancer
| Group | Version | Kind |
|---|---|---|
core | v1 | Service |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specServiceSpec | Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusServiceStatus | Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
allocateLoadBalancerNodePortsboolean | allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer does not rely on NodePorts. allocateLoadBalancerNodePorts may only be set for services with type LoadBalancer and will be cleared if the type is changed to any other type. This field is alpha-level and is only honored by servers that enable the ServiceLBNodePortControl feature. |
clusterIPstring | clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be blank) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
clusterIPsstring array | ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to the service; otherwise creation of the service will fail. This field may not be changed through updates unless the type field is also being changed to ExternalName (which requires this field to be empty) or the type field is being changed from ExternalName (in which case this field may optionally be specified, as describe above). Valid values are "None", empty string (""), or a valid IP address. Setting this to "None" makes a "headless service" (no virtual IP), which is useful when direct endpoint connections are preferred and proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. If this field is specified when creating a Service of type ExternalName, creation will fail. This field will be wiped when updating a Service to type ExternalName. If this field is not specified, it will be initialized from the clusterIP field. If this field is specified, clients must ensure that clusterIPs[0] and clusterIP have the same value. Unless the "IPv6DualStack" feature gate is enabled, this field is limited to one value, which must be the same as the clusterIP field. If the feature gate is enabled, this field may hold a maximum of two entries (dual-stack IPs, in either order). These IPs must correspond to the values of the ipFamilies field. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
externalIPsstring array | externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. |
externalNamestring | externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) and requires Type to be |
externalTrafficPolicystring | externalTrafficPolicy denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints. "Local" preserves the client source IP and avoids a second hop for LoadBalancer and Nodeport type services, but risks potentially imbalanced traffic spreading. "Cluster" obscures the client source IP and may cause a second hop to another node, but should have good overall load-spreading. |
healthCheckNodePortinteger | healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is in-range, and is not in use, it will be used. If not specified, a value will be automatically allocated. External systems (e.g. load-balancers) can use this port to determine if a given node holds endpoints for this service or not. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type). |
ipFamiliesstring array | IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service, and is gated by the "IPv6DualStack" feature gate. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field is specified manually, the requested family is available in the cluster, and ipFamilyPolicy allows it, it will be used; otherwise creation of the service will fail. This field is conditionally mutable: it allows for adding or removing a secondary IP family, but it does not allow changing the primary IP family of the Service. Valid values are "IPv4" and "IPv6". This field only applies to Services of types ClusterIP, NodePort, and LoadBalancer, and does apply to "headless" services. This field will be wiped when updating a Service to type ExternalName. This field may hold a maximum of two entries (dual-stack families, in either order). These families must correspond to the values of the clusterIPs field, if specified. Both clusterIPs and ipFamilies are governed by the ipFamilyPolicy field. |
ipFamilyPolicystring | IPFamilyPolicy represents the dual-stack-ness requested or required by this Service, and is gated by the "IPv6DualStack" feature gate. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a single IP family), "PreferDualStack" (two IP families on dual-stack configured clusters or a single IP family on single-stack clusters), or "RequireDualStack" (two IP families on dual-stack configured clusters, otherwise fail). The ipFamilies and clusterIPs fields depend on the value of this field. This field will be wiped when updating a service to type ExternalName. |
loadBalancerIPstring | Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature. |
loadBalancerSourceRangesstring array | If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ |
portsServicePort array patch strategy: merge patch merge key: port | The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
publishNotReadyAddressesboolean | publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a StatefulSet's Headless Service to propagate SRV DNS records for its Pods for the purpose of peer discovery. The Kubernetes controllers that generate Endpoints and EndpointSlice resources for Services interpret this to mean that all endpoints are considered "ready" even if the Pods themselves are not. Agents which consume only Kubernetes generated endpoints through the Endpoints or EndpointSlice resources can safely assume this behavior. |
selectorobject | Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: https://kubernetes.io/docs/concepts/services-networking/service/ |
sessionAffinitystring | Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies |
sessionAffinityConfigSessionAffinityConfig | sessionAffinityConfig contains the configurations of session affinity. |
topologyKeysstring array | topologyKeys is a preference-order list of topology keys which implementations of services should use to preferentially sort endpoints when accessing this Service, it can not be used at the same time as externalTrafficPolicy=Local. Topology keys must be valid label keys and at most 16 keys may be specified. Endpoints are chosen based on the first topology key with available backends. If this field is specified and all entries have no backends that match the topology of the client, the service has no backends for that client and connections should fail. The special value "*" may be used to mean "any topology". This catch-all value, if used, only makes sense as the last value in the list. If this is not specified or empty, no topology constraints will be applied. This field is alpha-level and is only honored by servers that enable the ServiceTopology feature. |
typestring | type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object or EndpointSlice objects. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a virtual IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the same endpoints as the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the same endpoints as the clusterIP. "ExternalName" aliases this service to the specified externalName. Several other fields do not apply to ExternalName services. More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types |
| Field | Description |
|---|---|
conditionsCondition array patch strategy: merge patch merge key: type | Current service state |
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer, if one is present. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsService array | List of services |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
kubectl command
$ echo 'kind: Service
apiVersion: v1
metadata:
name: service-example
spec:
ports:
- name: http
port: 80
targetPort: 80
selector:
app: nginx
type: LoadBalancer
' | kubectl create -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X POST -H 'Content-Type: application/yaml' --data '
kind: Service
apiVersion: v1
metadata:
name: service-example
spec:
ports:
- name: http
port: 80
targetPort: 80
selector:
app: nginx
type: LoadBalancer
' http://127.0.0.1:8001/api/v1/namespaces/default/services
service "service-example" created
{
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "service-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/service-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205767",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 80,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {}
}
}
create a Service
POST /api/v1/namespaces/{namespace}/services
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 200 Service | OK |
| 201 Service | Created |
| 202 Service | Accepted |
kubectl command
$ kubectl patch service -p \
'{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}'
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
{"spec":{"ports":[{"name":"http","port":80,"targetPort":8080}]}}' \
'http://127.0.0.1:8001/api/v1/namespaces/default/services/'
"" patched
{
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205995",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
partially update the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Service | OK |
kubectl command
$ echo 'apiVersion: v1
kind: Service
metadata:
name: deployment-example
resourceVersion: "2205995"
spec:
clusterIP: 10.183.250.161
ports:
- name: http
nodePort: 32417
port: 80
protocol: TCP
targetPort: 8080
selector:
app: nginx
sessionAffinity: None
type: LoadBalancer
' | kubectl replace -f -
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X PUT -H 'Content-Type: application/yaml' --data '
apiVersion: v1
kind: Service
metadata:
name: deployment-example
resourceVersion: "2205995"
spec:
clusterIP: 10.183.250.161
ports:
- name: http
nodePort: 32417
port: 80
protocol: TCP
targetPort: 8080
selector:
app: nginx
sessionAffinity: None
type: LoadBalancer
' http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
service "deployment-example" replaced
{
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2208672",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
replace the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 200 Service | OK |
| 201 Service | Created |
kubectl command
$ kubectl delete service deployment-example
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
gracePeriodSeconds: 0
orphanDependents: false
' 'http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example'
service "deployment-example" deleted
{
"kind": "Status",
"apiVersion": "v1",
"metadata": {},
"status": "Success",
"code": 200
}
delete a Service
DELETE /api/v1/namespaces/{namespace}/services/{name}
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
kubectl command
$ kubectl get service deployment-example -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET http://127.0.0.1:8001/api/v1/namespaces/default/services/deployment-example
{
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205995",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
{
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205995",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
read the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Service | OK |
kubectl command
$ kubectl get service -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/api/v1/namespaces/default/services'
list or watch objects of kind Service
GET /api/v1/namespaces/{namespace}/services
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ServiceList | OK |
list or watch objects of kind Service
GET /api/v1/services
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ServiceList | OK |
kubectl command
$ kubectl get service deployment-example --watch -o json
curl command (requires kubectl proxy to be running)
$ kubectl proxy
$ curl -X GET 'http://127.0.0.1:8001/api/v1/watch/namespaces/default/services/deployment-example'
{
"type": "ADDED",
"object": {
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205995",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
}
{
"type": "ADDED",
"object": {
"kind": "Service",
"apiVersion": "v1",
"metadata": {
"name": "deployment-example",
"namespace": "default",
"selfLink": "/api/v1/namespaces/default/services/deployment-example",
"uid": "93e5c731-9d30-11e6-9c54-42010a800148",
"resourceVersion": "2205995",
"creationTimestamp": "2016-10-28T17:04:24Z"
},
"spec": {
"ports": [
{
"name": "http",
"protocol": "TCP",
"port": 80,
"targetPort": 8080,
"nodePort": 32417
}
],
"selector": {
"app": "nginx"
},
"clusterIP": "10.183.250.161",
"type": "LoadBalancer",
"sessionAffinity": "None"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "104.198.186.106"
}
]
}
}
}
}
watch changes to an object of kind Service. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/services/{name}
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/services
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Service. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/services
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Service
PATCH /api/v1/namespaces/{namespace}/services/{name}/status
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Service | OK |
read status of the specified Service
GET /api/v1/namespaces/{namespace}/services/{name}/status
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Service | OK |
replace status of the specified Service
PUT /api/v1/namespaces/{namespace}/services/{name}/status
| Parameter | Description |
|---|---|
name | name of the Service |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyService |
| Code | Description |
|---|---|
| 200 Service | OK |
| 201 Service | Created |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Service
POST /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Service
DELETE /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Service
GET /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Service
HEAD /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Service
PUT /api/v1/namespaces/{namespace}/services/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the ServiceProxyOptions |
namespace | object name and auth scope, such as for teams and projects |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy. |
| Code | Description |
|---|---|
| 200 string | OK |
Config and Storage resources are responsible for injecting data into your applications and persisting data externally to your container.
Common resource types:
| Group | Version | Kind |
|---|---|---|
core | v1 | ConfigMap |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
binaryDataobject | BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process. Using this field will require 1.10+ apiserver and kubelet. |
dataobject | Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process. |
immutableboolean | Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsConfigMap array | Items is the list of ConfigMaps. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a ConfigMap
POST /api/v1/namespaces/{namespace}/configmaps
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyConfigMap |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
| 201 ConfigMap | Created |
| 202 ConfigMap | Accepted |
partially update the specified ConfigMap
PATCH /api/v1/namespaces/{namespace}/configmaps/{name}
| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
replace the specified ConfigMap
PUT /api/v1/namespaces/{namespace}/configmaps/{name}
| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyConfigMap |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
| 201 ConfigMap | Created |
delete a ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps/{name}
| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ConfigMap
DELETE /api/v1/namespaces/{namespace}/configmaps
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps/{name}
| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ConfigMap | OK |
list or watch objects of kind ConfigMap
GET /api/v1/namespaces/{namespace}/configmaps
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ConfigMapList | OK |
list or watch objects of kind ConfigMap
GET /api/v1/configmaps
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ConfigMapList | OK |
watch changes to an object of kind ConfigMap. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}
| Parameter | Description |
|---|---|
name | name of the ConfigMap |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/configmaps
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ConfigMap. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/configmaps
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | CSIDriver |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specCSIDriverSpec | Specification of the CSI Driver. |
| Field | Description |
|---|---|
attachRequiredboolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. |
fsGroupPolicystring | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. |
podInfoOnMountboolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. |
requiresRepublishboolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled. |
storageCapacityboolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This is an alpha field and only available when the CSIStorageCapacity feature is enabled. The default is false. |
tokenRequestsTokenRequest array | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled. |
volumeLifecycleModesstring array | volumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. This field is beta. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCSIDriver array | items is the list of CSIDriver |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CSIDriver
POST /apis/storage.k8s.io/v1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSIDriver |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 201 CSIDriver | Created |
| 202 CSIDriver | Accepted |
partially update the specified CSIDriver
PATCH /apis/storage.k8s.io/v1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
replace the specified CSIDriver
PUT /apis/storage.k8s.io/v1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSIDriver |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 201 CSIDriver | Created |
delete a CSIDriver
DELETE /apis/storage.k8s.io/v1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 202 CSIDriver | Accepted |
delete collection of CSIDriver
DELETE /apis/storage.k8s.io/v1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CSIDriver
GET /apis/storage.k8s.io/v1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
list or watch objects of kind CSIDriver
GET /apis/storage.k8s.io/v1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CSIDriverList | OK |
watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1/watch/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1/watch/csidrivers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | CSINode |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata.name must be the Kubernetes node name. |
specCSINodeSpec | spec is the specification of CSINode |
| Field | Description |
|---|---|
driversCSINodeDriver array patch strategy: merge patch merge key: name | drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCSINode array | items is the list of CSINode |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CSINode
POST /apis/storage.k8s.io/v1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSINode |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 201 CSINode | Created |
| 202 CSINode | Accepted |
partially update the specified CSINode
PATCH /apis/storage.k8s.io/v1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CSINode | OK |
replace the specified CSINode
PUT /apis/storage.k8s.io/v1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSINode |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 201 CSINode | Created |
delete a CSINode
DELETE /apis/storage.k8s.io/v1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 202 CSINode | Accepted |
delete collection of CSINode
DELETE /apis/storage.k8s.io/v1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CSINode
GET /apis/storage.k8s.io/v1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CSINode | OK |
list or watch objects of kind CSINode
GET /apis/storage.k8s.io/v1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CSINodeList | OK |
watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1/watch/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1/watch/csinodes
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | Secret |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
dataobject | Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 |
immutableboolean | Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil. This is a beta field enabled by ImmutableEphemeralVolumes feature gate. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
stringDataobject | stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. |
typestring | Used to facilitate programmatic handling of secret data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsSecret array | Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a Secret
POST /api/v1/namespaces/{namespace}/secrets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodySecret |
| Code | Description |
|---|---|
| 200 Secret | OK |
| 201 Secret | Created |
| 202 Secret | Accepted |
partially update the specified Secret
PATCH /api/v1/namespaces/{namespace}/secrets/{name}
| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Secret | OK |
replace the specified Secret
PUT /api/v1/namespaces/{namespace}/secrets/{name}
| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodySecret |
| Code | Description |
|---|---|
| 200 Secret | OK |
| 201 Secret | Created |
delete a Secret
DELETE /api/v1/namespaces/{namespace}/secrets/{name}
| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Secret
DELETE /api/v1/namespaces/{namespace}/secrets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Secret
GET /api/v1/namespaces/{namespace}/secrets/{name}
| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Secret | OK |
list or watch objects of kind Secret
GET /api/v1/namespaces/{namespace}/secrets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 SecretList | OK |
list or watch objects of kind Secret
GET /api/v1/secrets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 SecretList | OK |
watch changes to an object of kind Secret. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/secrets/{name}
| Parameter | Description |
|---|---|
name | name of the Secret |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/secrets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Secret. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/secrets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolumeClaim |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPersistentVolumeClaimSpec | Spec defines the desired characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
statusPersistentVolumeClaimStatus | Status represents the current information/status of a persistent volume claim. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
dataSourceTypedLocalObjectReference | This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) * An existing custom resource that implements data population (Alpha) In order to use custom resource types that implement data population, the AnyVolumeDataSource feature gate must be enabled. If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. |
resourcesResourceRequirements | Resources represents the minimum resources the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources |
selectorLabelSelector | A label query over volumes to consider for binding. |
storageClassNamestring | Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 |
volumeModestring | volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. |
volumeNamestring | VolumeName is the binding reference to the PersistentVolume backing this claim. |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 |
capacityobject | Represents the actual resources of the underlying volume. |
conditionsPersistentVolumeClaimCondition array patch strategy: merge patch merge key: type | Current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'ResizeStarted'. |
phasestring | Phase represents the current phase of PersistentVolumeClaim. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPersistentVolumeClaim array | A list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a PersistentVolumeClaim
POST /api/v1/namespaces/{namespace}/persistentvolumeclaims
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
| 202 PersistentVolumeClaim | Accepted |
partially update the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
replace the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
delete a PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 202 PersistentVolumeClaim | Accepted |
delete collection of PersistentVolumeClaim
DELETE /api/v1/namespaces/{namespace}/persistentvolumeclaims
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaimList | OK |
list or watch objects of kind PersistentVolumeClaim
GET /api/v1/persistentvolumeclaims
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaimList | OK |
watch changes to an object of kind PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/persistentvolumeclaims
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolumeClaim. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/persistentvolumeclaims
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PersistentVolumeClaim
PATCH /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
read status of the specified PersistentVolumeClaim
GET /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
replace status of the specified PersistentVolumeClaim
PUT /api/v1/namespaces/{namespace}/persistentvolumeclaims/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolumeClaim |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolumeClaim |
| Code | Description |
|---|---|
| 200 PersistentVolumeClaim | OK |
| 201 PersistentVolumeClaim | Created |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | StorageClass |
| Field | Description |
|---|---|
allowVolumeExpansionboolean | AllowVolumeExpansion shows whether the storage class allow volume expand |
allowedTopologiesTopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
mountOptionsstring array | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. |
parametersobject | Parameters holds the parameters for the provisioner that should create volumes of this storage class. |
provisionerstring | Provisioner indicates the type of the provisioner. |
reclaimPolicystring | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. |
volumeBindingModestring | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsStorageClass array | Items is the list of StorageClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a StorageClass
POST /apis/storage.k8s.io/v1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
| 202 StorageClass | Accepted |
partially update the specified StorageClass
PATCH /apis/storage.k8s.io/v1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
replace the specified StorageClass
PUT /apis/storage.k8s.io/v1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
delete a StorageClass
DELETE /apis/storage.k8s.io/v1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 202 StorageClass | Accepted |
delete collection of StorageClass
DELETE /apis/storage.k8s.io/v1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StorageClass
GET /apis/storage.k8s.io/v1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
list or watch objects of kind StorageClass
GET /apis/storage.k8s.io/v1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 StorageClassList | OK |
watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1/watch/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1/watch/storageclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | Volume |
| Field | Description |
|---|---|
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
azureFileAzureFileVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
cephfsCephFSVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
cinderCinderVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
configMapConfigMapVolumeSource | ConfigMap represents a configMap that should populate this volume |
csiCSIVolumeSource | CSI (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). |
downwardAPIDownwardAPIVolumeSource | DownwardAPI represents downward API about the pod that should populate this volume |
emptyDirEmptyDirVolumeSource | EmptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir |
ephemeralEphemeralVolumeSource | Ephemeral represents a volume that is handled by a cluster storage driver (Alpha feature). The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed. Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim). Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod. Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information. A pod can use both types of ephemeral volumes and persistent volumes at the same time. |
fcFCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. |
flexVolumeFlexVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
flockerFlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running |
gcePersistentDiskGCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
gitRepoGitRepoVolumeSource | GitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. |
glusterfsGlusterfsVolumeSource | Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md |
hostPathHostPathVolumeSource | HostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
iscsiISCSIVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md |
namestring | Volume's name. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
nfsNFSVolumeSource | NFS represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
persistentVolumeClaimPersistentVolumeClaimVolumeSource | PersistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims |
photonPersistentDiskPhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
portworxVolumePortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
projectedProjectedVolumeSource | Items for all in one resources secrets, configmaps, and downward API |
quobyteQuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime |
rbdRBDVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md |
scaleIOScaleIOVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
secretSecretVolumeSource | Secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
storageosStorageOSVolumeSource | StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. |
vsphereVolumeVsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
detachErrorVolumeError | The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a VolumeAttachment
POST /apis/storage.k8s.io/v1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
| 202 VolumeAttachment | Accepted |
partially update the specified VolumeAttachment
PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
PUT /apis/storage.k8s.io/v1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
delete a VolumeAttachment
DELETE /apis/storage.k8s.io/v1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 202 VolumeAttachment | Accepted |
delete collection of VolumeAttachment
DELETE /apis/storage.k8s.io/v1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
GET /apis/storage.k8s.io/v1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
GET /apis/storage.k8s.io/v1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1/watch/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1/watch/volumeattachments
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified VolumeAttachment
PATCH /apis/storage.k8s.io/v1/volumeattachments/{name}/status
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
read status of the specified VolumeAttachment
GET /apis/storage.k8s.io/v1/volumeattachments/{name}/status
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace status of the specified VolumeAttachment
PUT /apis/storage.k8s.io/v1/volumeattachments/{name}/status
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
Metadata resources are responsible for configuring behavior of your other Resources within the Cluster.
Common resource types:
| Group | Version | Kind |
|---|---|---|
apps | v1 | ControllerRevision |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
data | Data is the serialized representation of the state. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
revisioninteger | Revision indicates the revision of the state represented by Data. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsControllerRevision array | Items is the list of ControllerRevisions |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a ControllerRevision
POST /apis/apps/v1/namespaces/{namespace}/controllerrevisions
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
| 201 ControllerRevision | Created |
| 202 ControllerRevision | Accepted |
partially update the specified ControllerRevision
PATCH /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
replace the specified ControllerRevision
PUT /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyControllerRevision |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
| 201 ControllerRevision | Created |
delete a ControllerRevision
DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ControllerRevision
DELETE /apis/apps/v1/namespaces/{namespace}/controllerrevisions
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ControllerRevision
GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ControllerRevision | OK |
list or watch objects of kind ControllerRevision
GET /apis/apps/v1/namespaces/{namespace}/controllerrevisions
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
list or watch objects of kind ControllerRevision
GET /apis/apps/v1/controllerrevisions
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ControllerRevisionList | OK |
watch changes to an object of kind ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
| Parameter | Description |
|---|---|
name | name of the ControllerRevision |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ControllerRevision. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apps/v1/watch/controllerrevisions
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1 | CustomResourceDefinition |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCustomResourceDefinitionSpec | spec describes how the user wants the resources to appear |
statusCustomResourceDefinitionStatus | status indicates the actual state of the CustomResourceDefinition |
| Field | Description |
|---|---|
conversionCustomResourceConversion | conversion defines conversion settings for the CRD. |
groupstring | group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). |
namesCustomResourceDefinitionNames | names specify the resource and kind names for the custom resource. |
preserveUnknownFieldsboolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting `x-preserve-unknown-fields` to true in `spec.versions[*].schema.openAPIV3Schema`. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. |
scopestring | scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. |
versionsCustomResourceDefinitionVersion array | versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
acceptedNamesCustomResourceDefinitionNames | acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec. |
conditionsCustomResourceDefinitionCondition array | conditions indicate state for particular aspects of a CustomResourceDefinition |
storedVersionsstring array | storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCustomResourceDefinition array | items list individual CustomResourceDefinition objects |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a CustomResourceDefinition
POST /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| 202 CustomResourceDefinition | Accepted |
partially update the specified CustomResourceDefinition
PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
delete a CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
list or watch objects of kind CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinitionList | OK |
watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CustomResourceDefinition
PATCH /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
read status of the specified CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace status of the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| Group | Version | Kind |
|---|---|---|
events.k8s.io | v1 | Event |
| Field | Description |
|---|---|
actionstring | action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field cannot be empty for new Events and it can have at most 128 characters. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
deprecatedCountinteger | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedFirstTimestampTime | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedLastTimestampTime | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedSourceEventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. |
eventTimeMicroTime | eventTime is the time when this Event was first observed. It is required. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
notestring | note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. |
reasonstring | reason is why the action was taken. It is human-readable. This field cannot be empty for new Events and it can have at most 128 characters. |
regardingObjectReference | regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. |
relatedObjectReference | related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. |
reportingControllerstring | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. |
reportingInstancestring | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. |
seriesEventSeries | series is data about the Event series this event represents or nil if it's a singleton Event. |
typestring | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. This field cannot be empty for new Events. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsEvent array | items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create an Event
POST /apis/events.k8s.io/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
| 202 Event | Accepted |
partially update the specified Event
PATCH /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Event | OK |
replace the specified Event
PUT /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
delete an Event
DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Event
DELETE /apis/events.k8s.io/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Event
GET /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Event | OK |
list or watch objects of kind Event
GET /apis/events.k8s.io/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
list or watch objects of kind Event
GET /apis/events.k8s.io/v1/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/events.k8s.io/v1/watch/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | LimitRange |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specLimitRangeSpec | Spec defines the limits enforced. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
limitsLimitRangeItem array | Limits is the list of LimitRangeItem objects that are enforced. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsLimitRange array | Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a LimitRange
POST /api/v1/namespaces/{namespace}/limitranges
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLimitRange |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
| 201 LimitRange | Created |
| 202 LimitRange | Accepted |
partially update the specified LimitRange
PATCH /api/v1/namespaces/{namespace}/limitranges/{name}
| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
replace the specified LimitRange
PUT /api/v1/namespaces/{namespace}/limitranges/{name}
| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLimitRange |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
| 201 LimitRange | Created |
delete a LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges/{name}
| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of LimitRange
DELETE /api/v1/namespaces/{namespace}/limitranges
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified LimitRange
GET /api/v1/namespaces/{namespace}/limitranges/{name}
| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 LimitRange | OK |
list or watch objects of kind LimitRange
GET /api/v1/namespaces/{namespace}/limitranges
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LimitRangeList | OK |
list or watch objects of kind LimitRange
GET /api/v1/limitranges
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LimitRangeList | OK |
watch changes to an object of kind LimitRange. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/limitranges/{name}
| Parameter | Description |
|---|---|
name | name of the LimitRange |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/limitranges
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of LimitRange. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/limitranges
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
autoscaling | v1 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | behaviour of autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | current information about the autoscaler. |
| Field | Description |
|---|---|
maxReplicasinteger | upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas. |
minReplicasinteger | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. |
scaleTargetRefCrossVersionObjectReference | reference to scaled resource; horizontal pod autoscaler will learn the current resource consumption and will set the desired number of pods by using its Scale subresource. |
targetCPUUtilizationPercentageinteger | target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used. |
| Field | Description |
|---|---|
currentCPUUtilizationPercentageinteger | current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU. |
currentReplicasinteger | current number of replicas of pods managed by this autoscaler. |
desiredReplicasinteger | desired number of replicas of pods managed by this autoscaler. |
lastScaleTimeTime | last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed. |
observedGenerationinteger | most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
create a HorizontalPodAutoscaler
POST /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| 202 HorizontalPodAutoscaler | Accepted |
partially update the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
delete a HorizontalPodAutoscaler
DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
DELETE /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v1/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v1/watch/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v1/watch/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1 | MutatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
webhooksMutatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsMutatingWebhookConfiguration array | List of MutatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a MutatingWebhookConfiguration
POST /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
| 202 MutatingWebhookConfiguration | Accepted |
partially update the specified MutatingWebhookConfiguration
PATCH /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
replace the specified MutatingWebhookConfiguration
PUT /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
delete a MutatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of MutatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified MutatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
list or watch objects of kind MutatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfigurationList | OK |
watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/admissionregistration.k8s.io/v1/watch/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1 | ValidatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
webhooksValidatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsValidatingWebhookConfiguration array | List of ValidatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ValidatingWebhookConfiguration
POST /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
| 202 ValidatingWebhookConfiguration | Accepted |
partially update the specified ValidatingWebhookConfiguration
PATCH /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
replace the specified ValidatingWebhookConfiguration
PUT /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
delete a ValidatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ValidatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ValidatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
list or watch objects of kind ValidatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfigurationList | OK |
watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/admissionregistration.k8s.io/v1/watch/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PodTemplate |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
templatePodTemplateSpec | Template defines the pods that will be created from this pod template. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPodSpec | Specification of the desired behavior of the pod. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPodTemplate array | List of pod templates |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a PodTemplate
POST /api/v1/namespaces/{namespace}/podtemplates
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodTemplate |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
| 201 PodTemplate | Created |
| 202 PodTemplate | Accepted |
partially update the specified PodTemplate
PATCH /api/v1/namespaces/{namespace}/podtemplates/{name}
| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
replace the specified PodTemplate
PUT /api/v1/namespaces/{namespace}/podtemplates/{name}
| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodTemplate |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
| 201 PodTemplate | Created |
delete a PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates/{name}
| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
| 202 PodTemplate | Accepted |
delete collection of PodTemplate
DELETE /api/v1/namespaces/{namespace}/podtemplates
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates/{name}
| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PodTemplate | OK |
list or watch objects of kind PodTemplate
GET /api/v1/namespaces/{namespace}/podtemplates
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodTemplateList | OK |
list or watch objects of kind PodTemplate
GET /api/v1/podtemplates
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodTemplateList | OK |
watch changes to an object of kind PodTemplate. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/podtemplates/{name}
| Parameter | Description |
|---|---|
name | name of the PodTemplate |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/podtemplates
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodTemplate. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/podtemplates
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | PodDisruptionBudget |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specPodDisruptionBudgetSpec | Specification of the desired behavior of the PodDisruptionBudget. |
statusPodDisruptionBudgetStatus | Most recently observed status of the PodDisruptionBudget. |
| Field | Description |
|---|---|
maxUnavailable | An eviction is allowed if at most "maxUnavailable" pods selected by "selector" are unavailable after the eviction, i.e. even in absence of the evicted pod. For example, one can prevent all voluntary evictions by specifying 0. This is a mutually exclusive setting with "minAvailable". |
minAvailable | An eviction is allowed if at least "minAvailable" pods selected by "selector" will still be available after the eviction, i.e. even in the absence of the evicted pod. So for example you can prevent all voluntary evictions by specifying "100%". |
selectorLabelSelector | Label query over pods whose evictions are managed by the disruption budget. |
| Field | Description |
|---|---|
currentHealthyinteger | current number of healthy pods |
desiredHealthyinteger | minimum desired number of healthy pods |
disruptedPodsobject | DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod will be in this map from the time when the API server processed the eviction request to the time when the pod is seen by PDB controller as having been marked for deletion (or after a timeout). The key in the map is the name of the pod and the value is the time when the API server processed the eviction request. If the deletion didn't occur and a pod is still there it will be removed from the list automatically by PodDisruptionBudget controller after some time. If everything goes smooth this map should be empty for the most of the time. Large number of entries in the map may indicate problems with pod deletions. |
disruptionsAllowedinteger | Number of pod disruptions that are currently allowed. |
expectedPodsinteger | total number of pods counted by this disruption budget |
observedGenerationinteger | Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPodDisruptionBudget array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a PodDisruptionBudget
POST /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
| 202 PodDisruptionBudget | Accepted |
partially update the specified PodDisruptionBudget
PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
replace the specified PodDisruptionBudget
PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
delete a PodDisruptionBudget
DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PodDisruptionBudget
DELETE /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodDisruptionBudget
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
list or watch objects of kind PodDisruptionBudget
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudgetList | OK |
list or watch objects of kind PodDisruptionBudget
GET /apis/policy/v1beta1/poddisruptionbudgets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudgetList | OK |
watch changes to an object of kind PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets/{name}
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/policy/v1beta1/watch/namespaces/{namespace}/poddisruptionbudgets
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodDisruptionBudget. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/policy/v1beta1/watch/poddisruptionbudgets
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PodDisruptionBudget
PATCH /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
read status of the specified PodDisruptionBudget
GET /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
replace status of the specified PodDisruptionBudget
PUT /apis/policy/v1beta1/namespaces/{namespace}/poddisruptionbudgets/{name}/status
| Parameter | Description |
|---|---|
name | name of the PodDisruptionBudget |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodDisruptionBudget |
| Code | Description |
|---|---|
| 200 PodDisruptionBudget | OK |
| 201 PodDisruptionBudget | Created |
| Group | Version | Kind |
|---|---|---|
scheduling.k8s.io | v1 | PriorityClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
descriptionstring | description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefaultboolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
preemptionPolicystring | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
valueinteger | The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPriorityClass array | items is the list of PriorityClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PriorityClass
POST /apis/scheduling.k8s.io/v1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
| 202 PriorityClass | Accepted |
partially update the specified PriorityClass
PATCH /apis/scheduling.k8s.io/v1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
replace the specified PriorityClass
PUT /apis/scheduling.k8s.io/v1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
delete a PriorityClass
DELETE /apis/scheduling.k8s.io/v1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityClass
DELETE /apis/scheduling.k8s.io/v1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityClass
GET /apis/scheduling.k8s.io/v1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
list or watch objects of kind PriorityClass
GET /apis/scheduling.k8s.io/v1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PriorityClassList | OK |
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/scheduling.k8s.io/v1/watch/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/scheduling.k8s.io/v1/watch/priorityclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
policy | v1beta1 | PodSecurityPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPodSecurityPolicySpec | spec defines the policy enforced. |
| Field | Description |
|---|---|
allowPrivilegeEscalationboolean | allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true. |
allowedCSIDriversAllowedCSIDriver array | AllowedCSIDrivers is an allowlist of inline CSI drivers that must be explicitly set to be embedded within a pod spec. An empty value indicates that any CSI driver can be used for inline ephemeral volumes. This is a beta field, and is only honored if the API server enables the CSIInlineVolume feature gate. |
allowedCapabilitiesstring array | allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author's discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities. |
allowedFlexVolumesAllowedFlexVolume array | allowedFlexVolumes is an allowlist of Flexvolumes. Empty or nil indicates that all Flexvolumes may be used. This parameter is effective only when the usage of the Flexvolumes is allowed in the "volumes" field. |
allowedHostPathsAllowedHostPath array | allowedHostPaths is an allowlist of host paths. Empty indicates that all host paths may be used. |
allowedProcMountTypesstring array | AllowedProcMountTypes is an allowlist of allowed ProcMountTypes. Empty or nil indicates that only the DefaultProcMountType may be used. This requires the ProcMountType feature flag to be enabled. |
allowedUnsafeSysctlsstring array | allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to allowlist all allowed unsafe sysctls explicitly to avoid rejection. Examples: e.g. "foo/*" allows "foo/bar", "foo/baz", etc. e.g. "foo.*" allows "foo.bar", "foo.baz", etc. |
defaultAddCapabilitiesstring array | defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability. You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list. |
defaultAllowPrivilegeEscalationboolean | defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process. |
forbiddenSysctlsstring array | forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in "*" in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden. Examples: e.g. "foo/*" forbids "foo/bar", "foo/baz", etc. e.g. "foo.*" forbids "foo.bar", "foo.baz", etc. |
fsGroupFSGroupStrategyOptions | fsGroup is the strategy that will dictate what fs group is used by the SecurityContext. |
hostIPCboolean | hostIPC determines if the policy allows the use of HostIPC in the pod spec. |
hostNetworkboolean | hostNetwork determines if the policy allows the use of HostNetwork in the pod spec. |
hostPIDboolean | hostPID determines if the policy allows the use of HostPID in the pod spec. |
hostPortsHostPortRange array | hostPorts determines which host port ranges are allowed to be exposed. |
privilegedboolean | privileged determines if a pod can request to be run as privileged. |
readOnlyRootFilesystemboolean | readOnlyRootFilesystem when set to true will force containers to run with a read only root file system. If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to. |
requiredDropCapabilitiesstring array | requiredDropCapabilities are the capabilities that will be dropped from the container. These are required to be dropped and cannot be added. |
runAsGroupRunAsGroupStrategyOptions | RunAsGroup is the strategy that will dictate the allowable RunAsGroup values that may be set. If this field is omitted, the pod's RunAsGroup can take any value. This field requires the RunAsGroup feature gate to be enabled. |
runAsUserRunAsUserStrategyOptions | runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set. |
runtimeClassRuntimeClassStrategyOptions | runtimeClass is the strategy that will dictate the allowable RuntimeClasses for a pod. If this field is omitted, the pod's runtimeClassName field is unrestricted. Enforcement of this field depends on the RuntimeClass feature gate being enabled. |
seLinuxSELinuxStrategyOptions | seLinux is the strategy that will dictate the allowable labels that may be set. |
supplementalGroupsSupplementalGroupsStrategyOptions | supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext. |
volumesstring array | volumes is an allowlist of volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use '\*'. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPodSecurityPolicy array | items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PodSecurityPolicy
POST /apis/policy/v1beta1/podsecuritypolicies
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
| 202 PodSecurityPolicy | Accepted |
partially update the specified PodSecurityPolicy
PATCH /apis/policy/v1beta1/podsecuritypolicies/{name}
| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
replace the specified PodSecurityPolicy
PUT /apis/policy/v1beta1/podsecuritypolicies/{name}
| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPodSecurityPolicy |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
| 201 PodSecurityPolicy | Created |
delete a PodSecurityPolicy
DELETE /apis/policy/v1beta1/podsecuritypolicies/{name}
| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
| 202 PodSecurityPolicy | Accepted |
delete collection of PodSecurityPolicy
DELETE /apis/policy/v1beta1/podsecuritypolicies
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PodSecurityPolicy
GET /apis/policy/v1beta1/podsecuritypolicies/{name}
| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicy | OK |
list or watch objects of kind PodSecurityPolicy
GET /apis/policy/v1beta1/podsecuritypolicies
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PodSecurityPolicyList | OK |
watch changes to an object of kind PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/policy/v1beta1/watch/podsecuritypolicies/{name}
| Parameter | Description |
|---|---|
name | name of the PodSecurityPolicy |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PodSecurityPolicy. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/policy/v1beta1/watch/podsecuritypolicies
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
Cluster resources are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1 | APIService |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specAPIServiceSpec | Spec contains information for locating and communicating with a server |
statusAPIServiceStatus | Status contains derived information about an API server |
| Field | Description |
|---|---|
caBundlestring | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. |
groupstring | Group is the API group name this server hosts |
groupPriorityMinimuminteger | GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s |
insecureSkipTLSVerifyboolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. |
serviceServiceReference | Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. |
versionstring | Version is the API version this server hosts. For example, "v1" |
versionPriorityinteger | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
conditionsAPIServiceCondition array patch strategy: merge patch merge key: type | Current service state of apiService. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsAPIService array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create an APIService
POST /apis/apiregistration.k8s.io/v1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| 202 APIService | Accepted |
partially update the specified APIService
PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace the specified APIService
PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
delete an APIService
DELETE /apis/apiregistration.k8s.io/v1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of APIService
DELETE /apis/apiregistration.k8s.io/v1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified APIService
GET /apis/apiregistration.k8s.io/v1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 APIService | OK |
list or watch objects of kind APIService
GET /apis/apiregistration.k8s.io/v1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 APIServiceList | OK |
watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apiregistration.k8s.io/v1/watch/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apiregistration.k8s.io/v1/watch/apiservices
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified APIService
PATCH /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
read status of the specified APIService
GET /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace status of the specified APIService
PUT /apis/apiregistration.k8s.io/v1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | Binding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
targetObjectReference | The target object that you want to bind to the standard object. |
create a Binding
POST /api/v1/namespaces/{namespace}/bindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyBinding |
| Code | Description |
|---|---|
| 200 Binding | OK |
| 201 Binding | Created |
| 202 Binding | Accepted |
| Group | Version | Kind |
|---|---|---|
certificates.k8s.io | v1 | CertificateSigningRequest |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCertificateSigningRequestSpec | spec contains the certificate request, and is immutable after creation. Only the request, signerName, and usages fields can be set on creation. Other fields are derived by Kubernetes and cannot be modified by users. |
statusCertificateSigningRequestStatus | status contains information about whether the request is approved or denied, and the certificate issued by the signer, or the failure condition indicating signer failure. |
| Field | Description |
|---|---|
extraobject | extra contains extra attributes of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. |
groupsstring array | groups contains group membership of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. |
requeststring | request contains an x509 certificate signing request encoded in a "CERTIFICATE REQUEST" PEM block. When serialized as JSON or YAML, the data is additionally base64-encoded. |
signerNamestring | signerName indicates the requested signer, and is a qualified name. List/watch requests for CertificateSigningRequests can filter on this field using a "spec.signerName=NAME" fieldSelector. Well-known Kubernetes signers are: 1. "kubernetes.io/kube-apiserver-client": issues client certificates that can be used to authenticate to kube-apiserver. Requests for this signer are never auto-approved by kube-controller-manager, can be issued by the "csrsigning" controller in kube-controller-manager. 2. "kubernetes.io/kube-apiserver-client-kubelet": issues client certificates that kubelets use to authenticate to kube-apiserver. Requests for this signer can be auto-approved by the "csrapproving" controller in kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. 3. "kubernetes.io/kubelet-serving" issues serving certificates that kubelets use to serve TLS endpoints, which kube-apiserver can connect to securely. Requests for this signer are never auto-approved by kube-controller-manager, and can be issued by the "csrsigning" controller in kube-controller-manager. More details are available at https://k8s.io/docs/reference/access-authn-authz/certificate-signing-requests/#kubernetes-signers Custom signerNames can also be specified. The signer defines: 1. Trust distribution: how trust (CA bundles) are distributed. 2. Permitted subjects: and behavior when a disallowed subject is requested. 3. Required, permitted, or forbidden x509 extensions in the request (including whether subjectAltNames are allowed, which types, restrictions on allowed values) and behavior when a disallowed extension is requested. 4. Required, permitted, or forbidden key usages / extended key usages. 5. Expiration/certificate lifetime: whether it is fixed by the signer, configurable by the admin. 6. Whether or not requests for CA certificates are allowed. |
uidstring | uid contains the uid of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. |
usagesstring array | usages specifies a set of key usages requested in the issued certificate. Requests for TLS client certificates typically request: "digital signature", "key encipherment", "client auth". Requests for TLS serving certificates typically request: "key encipherment", "digital signature", "server auth". Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" |
usernamestring | username contains the name of the user that created the CertificateSigningRequest. Populated by the API server on creation and immutable. |
| Field | Description |
|---|---|
certificatestring | certificate is populated with an issued certificate by the signer after an Approved condition is present. This field is set via the /status subresource. Once populated, this field is immutable. If the certificate signing request is denied, a condition of type "Denied" is added and this field remains empty. If the signer cannot issue the certificate, a condition of type "Failed" is added and this field remains empty. Validation requirements: 1. certificate must contain one or more PEM blocks. 2. All PEM blocks must have the "CERTIFICATE" label, contain no headers, and the encoded data must be a BER-encoded ASN.1 Certificate structure as described in section 4 of RFC5280. 3. Non-PEM content may appear before or after the "CERTIFICATE" PEM blocks and is unvalidated, to allow for explanatory text as described in section 5.2 of RFC7468. If more than one PEM block is present, and the definition of the requested spec.signerName does not indicate otherwise, the first block is the issued certificate, and subsequent blocks should be treated as intermediate certificates and presented in TLS handshakes. The certificate is encoded in PEM format. When serialized as JSON or YAML, the data is additionally base64-encoded, so it consists of: base64( -----BEGIN CERTIFICATE----- ... -----END CERTIFICATE----- ) |
conditionsCertificateSigningRequestCondition array | conditions applied to the request. Known conditions are "Approved", "Denied", and "Failed". |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCertificateSigningRequest array | items is a collection of CertificateSigningRequest objects |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a CertificateSigningRequest
POST /apis/certificates.k8s.io/v1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
| 202 CertificateSigningRequest | Accepted |
partially update the specified CertificateSigningRequest
PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace the specified CertificateSigningRequest
PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
delete a CertificateSigningRequest
DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CertificateSigningRequest
DELETE /apis/certificates.k8s.io/v1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CertificateSigningRequest
GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
list or watch objects of kind CertificateSigningRequest
GET /apis/certificates.k8s.io/v1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequestList | OK |
watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/certificates.k8s.io/v1/watch/certificatesigningrequests
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CertificateSigningRequest
PATCH /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
read status of the specified CertificateSigningRequest
GET /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace status of the specified CertificateSigningRequest
PUT /apis/certificates.k8s.io/v1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
POST /apis/rbac.authorization.k8s.io/v1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
| 202 ClusterRole | Accepted |
partially update the specified ClusterRole
PATCH /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
PUT /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
delete a ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
GET /apis/rbac.authorization.k8s.io/v1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
GET /apis/rbac.authorization.k8s.io/v1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterroles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
POST /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
| 202 ClusterRoleBinding | Accepted |
partially update the specified ClusterRoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
PUT /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/clusterrolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | ComponentStatus |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
conditionsComponentCondition array patch strategy: merge patch merge key: type | List of component conditions observed |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsComponentStatus array | List of ComponentStatus objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
read the specified ComponentStatus
GET /api/v1/componentstatuses/{name}
| Parameter | Description |
|---|---|
name | name of the ComponentStatus |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ComponentStatus | OK |
list objects of kind ComponentStatus
GET /api/v1/componentstatuses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ComponentStatusList | OK |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1beta1 | FlowSchema |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specFlowSchemaSpec | `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusFlowSchemaStatus | `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
distinguisherMethodFlowDistinguisherMethod | `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. |
matchingPrecedenceinteger | `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. |
priorityLevelConfigurationPriorityLevelConfigurationReference | `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. |
rulesPolicyRulesWithSubjects array | `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. |
| Field | Description |
|---|---|
conditionsFlowSchemaCondition array | `conditions` is a list of the current states of FlowSchema. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsFlowSchema array | `items` is a list of FlowSchemas. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a FlowSchema
POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
| 202 FlowSchema | Accepted |
partially update the specified FlowSchema
PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
replace the specified FlowSchema
PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
delete a FlowSchema
DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of FlowSchema
DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
list or watch objects of kind FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 FlowSchemaList | OK |
watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/flowschemas
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified FlowSchema
PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
read status of the specified FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
replace status of the specified FlowSchema
PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
| Group | Version | Kind |
|---|---|---|
coordination.k8s.io | v1 | Lease |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specLeaseSpec | Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
acquireTimeMicroTime | acquireTime is a time when the current lease was acquired. |
holderIdentitystring | holderIdentity contains the identity of the holder of a current lease. |
leaseDurationSecondsinteger | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. |
leaseTransitionsinteger | leaseTransitions is the number of transitions of a lease between holders. |
renewTimeMicroTime | renewTime is a time when the current holder of a lease has last updated the lease. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsLease array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a Lease
POST /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLease |
| Code | Description |
|---|---|
| 200 Lease | OK |
| 201 Lease | Created |
| 202 Lease | Accepted |
partially update the specified Lease
PATCH /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Lease | OK |
replace the specified Lease
PUT /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLease |
| Code | Description |
|---|---|
| 200 Lease | OK |
| 201 Lease | Created |
delete a Lease
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Lease
DELETE /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Lease
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Lease | OK |
list or watch objects of kind Lease
GET /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LeaseList | OK |
list or watch objects of kind Lease
GET /apis/coordination.k8s.io/v1/leases
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LeaseList | OK |
watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/coordination.k8s.io/v1/watch/leases
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | LocalSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
create a LocalSubjectAccessReview
POST /apis/authorization.k8s.io/v1/namespaces/{namespace}/localsubjectaccessreviews
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyLocalSubjectAccessReview |
| Code | Description |
|---|---|
| 200 LocalSubjectAccessReview | OK |
| 201 LocalSubjectAccessReview | Created |
| 202 LocalSubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
core | v1 | Namespace |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specNamespaceSpec | Spec defines the behavior of the Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusNamespaceStatus | Status describes the current status of a Namespace. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
finalizersstring array | Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
| Field | Description |
|---|---|
conditionsNamespaceCondition array patch strategy: merge patch merge key: type | Represents the latest available observations of a namespace's current state. |
phasestring | Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsNamespace array | Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a Namespace
POST /api/v1/namespaces
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
| 202 Namespace | Accepted |
partially update the specified Namespace
PATCH /api/v1/namespaces/{name}
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Namespace | OK |
replace the specified Namespace
PUT /api/v1/namespaces/{name}
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
delete a Namespace
DELETE /api/v1/namespaces/{name}
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
read the specified Namespace
GET /api/v1/namespaces/{name}
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Namespace | OK |
list or watch objects of kind Namespace
GET /api/v1/namespaces
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 NamespaceList | OK |
watch changes to an object of kind Namespace. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{name}
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Namespace. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Namespace
PATCH /api/v1/namespaces/{name}/status
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Namespace | OK |
read status of the specified Namespace
GET /api/v1/namespaces/{name}/status
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Namespace | OK |
replace status of the specified Namespace
PUT /api/v1/namespaces/{name}/status
| Parameter | Description |
|---|---|
name | name of the Namespace |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNamespace |
| Code | Description |
|---|---|
| 200 Namespace | OK |
| 201 Namespace | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | Node |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specNodeSpec | Spec defines the behavior of a node. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusNodeStatus | Most recently observed status of the node. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
configSourceNodeConfigSource | If specified, the source to get node configuration from The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field |
externalIDstring | Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966 |
podCIDRstring | PodCIDR represents the pod IP range assigned to the node. |
podCIDRsstring array patch strategy: merge | podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each of IPv4 and IPv6. |
providerIDstring | ID of the node assigned by the cloud provider in the format: <ProviderName>://<ProviderSpecificNodeID> |
taintsTaint array | If specified, the node's taints. |
unschedulableboolean | Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration |
| Field | Description |
|---|---|
addressesNodeAddress array patch strategy: merge patch merge key: type | List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses Note: This field is declared as mergeable, but the merge key is not sufficiently unique, which can cause data corruption when it is merged. Callers should instead use a full-replacement patch. See http://pr.k8s.io/79391 for an example. |
allocatableobject | Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity. |
capacityobject | Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
conditionsNodeCondition array patch strategy: merge patch merge key: type | Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/concepts/nodes/node/#condition |
configNodeConfigStatus | Status of the config assigned to the node via the dynamic Kubelet config feature. |
daemonEndpointsNodeDaemonEndpoints | Endpoints of daemons running on the Node. |
imagesContainerImage array | List of container images on this node |
nodeInfoNodeSystemInfo | Set of ids/uuids to uniquely identify the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#info |
phasestring | NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated. |
volumesAttachedAttachedVolume array | List of volumes that are attached to the node. |
volumesInUsestring array | List of attachable volumes in use (mounted) by the node. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsNode array | List of nodes |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a Node
POST /api/v1/nodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
| 202 Node | Accepted |
partially update the specified Node
PATCH /api/v1/nodes/{name}
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Node | OK |
replace the specified Node
PUT /api/v1/nodes/{name}
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
delete a Node
DELETE /api/v1/nodes/{name}
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Node
DELETE /api/v1/nodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Node
GET /api/v1/nodes/{name}
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Node | OK |
list or watch objects of kind Node
GET /api/v1/nodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 NodeList | OK |
watch changes to an object of kind Node. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/nodes/{name}
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Node. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/nodes
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Node
PATCH /api/v1/nodes/{name}/status
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Node | OK |
read status of the specified Node
GET /api/v1/nodes/{name}/status
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Node | OK |
replace status of the specified Node
PUT /api/v1/nodes/{name}/status
| Parameter | Description |
|---|---|
name | name of the Node |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNode |
| Code | Description |
|---|---|
| 200 Node | OK |
| 201 Node | Created |
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect POST requests to proxy of Node
POST /api/v1/nodes/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect DELETE requests to proxy of Node
DELETE /api/v1/nodes/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect GET requests to proxy of Node
GET /api/v1/nodes/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Node
HEAD /api/v1/nodes/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect HEAD requests to proxy of Node
HEAD /api/v1/nodes/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
connect PUT requests to proxy of Node
PUT /api/v1/nodes/{name}/proxy/{path}
| Parameter | Description |
|---|---|
name | name of the NodeProxyOptions |
path | path to the resource |
| Parameter | Description |
|---|---|
path | Path is the URL path to use for the current proxy request to node. |
| Code | Description |
|---|---|
| 200 string | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | PersistentVolume |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPersistentVolumeSpec | Spec defines a specification of a persistent volume owned by the cluster. Provisioned by an administrator. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
statusPersistentVolumeStatus | Status represents the current information/status for the persistent volume. Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes |
| Field | Description |
|---|---|
accessModesstring array | AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes |
awsElasticBlockStoreAWSElasticBlockStoreVolumeSource | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |
azureDiskAzureDiskVolumeSource | AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. |
azureFileAzureFilePersistentVolumeSource | AzureFile represents an Azure File Service mount on the host and bind mount to the pod. |
capacityobject | A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity |
cephfsCephFSPersistentVolumeSource | CephFS represents a Ceph FS mount on the host that shares a pod's lifetime |
cinderCinderPersistentVolumeSource | Cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md |
claimRefObjectReference | ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding |
csiCSIPersistentVolumeSource | CSI represents storage that is handled by an external CSI driver (Beta feature). |
fcFCVolumeSource | FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. |
flexVolumeFlexPersistentVolumeSource | FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. |
flockerFlockerVolumeSource | Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running |
gcePersistentDiskGCEPersistentDiskVolumeSource | GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk |
glusterfsGlusterfsPersistentVolumeSource | Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md |
hostPathHostPathVolumeSource | HostPath represents a directory on the host. Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath |
iscsiISCSIPersistentVolumeSource | ISCSI represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. Provisioned by an admin. |
localLocalVolumeSource | Local represents directly-attached storage with node affinity |
mountOptionsstring array | A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options |
nfsNFSVolumeSource | NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs |
nodeAffinityVolumeNodeAffinity | NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume. |
persistentVolumeReclaimPolicystring | What happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming |
photonPersistentDiskPhotonPersistentDiskVolumeSource | PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine |
portworxVolumePortworxVolumeSource | PortworxVolume represents a portworx volume attached and mounted on kubelets host machine |
quobyteQuobyteVolumeSource | Quobyte represents a Quobyte mount on the host that shares a pod's lifetime |
rbdRBDPersistentVolumeSource | RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md |
scaleIOScaleIOPersistentVolumeSource | ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. |
storageClassNamestring | Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass. |
storageosStorageOSPersistentVolumeSource | StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md |
volumeModestring | volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec. |
vsphereVolumeVsphereVirtualDiskVolumeSource | VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine |
| Field | Description |
|---|---|
messagestring | A human-readable message indicating details about why the volume is in this state. |
phasestring | Phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase |
reasonstring | Reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPersistentVolume array | List of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a PersistentVolume
POST /api/v1/persistentvolumes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
| 202 PersistentVolume | Accepted |
partially update the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
replace the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
delete a PersistentVolume
DELETE /api/v1/persistentvolumes/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 202 PersistentVolume | Accepted |
delete collection of PersistentVolume
DELETE /api/v1/persistentvolumes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
list or watch objects of kind PersistentVolume
GET /api/v1/persistentvolumes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PersistentVolumeList | OK |
watch changes to an object of kind PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/persistentvolumes/{name}
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PersistentVolume. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/persistentvolumes
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PersistentVolume
PATCH /api/v1/persistentvolumes/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
read status of the specified PersistentVolume
GET /api/v1/persistentvolumes/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
replace status of the specified PersistentVolume
PUT /api/v1/persistentvolumes/{name}/status
| Parameter | Description |
|---|---|
name | name of the PersistentVolume |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPersistentVolume |
| Code | Description |
|---|---|
| 200 PersistentVolume | OK |
| 201 PersistentVolume | Created |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1beta1 | PriorityLevelConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPriorityLevelConfigurationSpec | `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusPriorityLevelConfigurationStatus | `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
limitedLimitedPriorityLevelConfiguration | `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. |
typestring | `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. |
| Field | Description |
|---|---|
conditionsPriorityLevelConfigurationCondition array | `conditions` is the current state of "request-priority". |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPriorityLevelConfiguration array | `items` is a list of request-priorities. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PriorityLevelConfiguration
POST /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
| 202 PriorityLevelConfiguration | Accepted |
partially update the specified PriorityLevelConfiguration
PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
replace the specified PriorityLevelConfiguration
PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
delete a PriorityLevelConfiguration
DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityLevelConfiguration
DELETE /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
list or watch objects of kind PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfigurationList | OK |
watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/watch/prioritylevelconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PriorityLevelConfiguration
PATCH /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
read status of the specified PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
replace status of the specified PriorityLevelConfiguration
PUT /apis/flowcontrol.apiserver.k8s.io/v1beta1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
| Group | Version | Kind |
|---|---|---|
core | v1 | ResourceQuota |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specResourceQuotaSpec | Spec defines the desired quota. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusResourceQuotaStatus | Status defines the actual enforced quota and its current usage. https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
hardobject | hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
scopeSelectorScopeSelector | scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota but expressed using ScopeSelectorOperator in combination with possible values. For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. |
scopesstring array | A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects. |
| Field | Description |
|---|---|
hardobject | Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
usedobject | Used is the current observed total usage of the resource in the namespace. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsResourceQuota array | Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ResourceQuota
POST /api/v1/namespaces/{namespace}/resourcequotas
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
| 202 ResourceQuota | Accepted |
partially update the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
replace the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
delete a ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas/{name}
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 202 ResourceQuota | Accepted |
delete collection of ResourceQuota
DELETE /api/v1/namespaces/{namespace}/resourcequotas
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
list or watch objects of kind ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ResourceQuotaList | OK |
list or watch objects of kind ResourceQuota
GET /api/v1/resourcequotas
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ResourceQuotaList | OK |
watch changes to an object of kind ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/resourcequotas/{name}
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/resourcequotas
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ResourceQuota. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/resourcequotas
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified ResourceQuota
PATCH /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
read status of the specified ResourceQuota
GET /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
replace status of the specified ResourceQuota
PUT /api/v1/namespaces/{namespace}/resourcequotas/{name}/status
| Parameter | Description |
|---|---|
name | name of the ResourceQuota |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyResourceQuota |
| Code | Description |
|---|---|
| 200 ResourceQuota | OK |
| 201 ResourceQuota | Created |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
| 202 Role | Accepted |
partially update the specified Role
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
delete a Role
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
POST /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1/watch/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1 | RuntimeClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
handlerstring | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
overheadOverhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/ This field is in beta starting v1.18 and is only honored by servers that enable the PodOverhead feature. |
schedulingScheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRuntimeClass array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a RuntimeClass
POST /apis/node.k8s.io/v1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
| 202 RuntimeClass | Accepted |
partially update the specified RuntimeClass
PATCH /apis/node.k8s.io/v1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
replace the specified RuntimeClass
PUT /apis/node.k8s.io/v1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
delete a RuntimeClass
DELETE /apis/node.k8s.io/v1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RuntimeClass
DELETE /apis/node.k8s.io/v1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RuntimeClass
GET /apis/node.k8s.io/v1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
list or watch objects of kind RuntimeClass
GET /apis/node.k8s.io/v1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RuntimeClassList | OK |
watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/node.k8s.io/v1/watch/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/node.k8s.io/v1/watch/runtimeclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SelfSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
create a SelfSubjectAccessReview
POST /apis/authorization.k8s.io/v1/selfsubjectaccessreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectAccessReview |
| Code | Description |
|---|---|
| 200 SelfSubjectAccessReview | OK |
| 201 SelfSubjectAccessReview | Created |
| 202 SelfSubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SelfSubjectRulesReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. |
statusSubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform. |
| Field | Description |
|---|---|
namespacestring | Namespace to evaluate rules for. Required. |
create a SelfSubjectRulesReview
POST /apis/authorization.k8s.io/v1/selfsubjectrulesreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectRulesReview |
| Code | Description |
|---|---|
| 200 SelfSubjectRulesReview | OK |
| 201 SelfSubjectRulesReview | Created |
| 202 SelfSubjectRulesReview | Accepted |
| Group | Version | Kind |
|---|---|---|
core | v1 | ServiceAccount |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
automountServiceAccountTokenboolean | AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level. |
imagePullSecretsLocalObjectReference array | ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
secretsObjectReference array patch strategy: merge patch merge key: name | Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. More info: https://kubernetes.io/docs/concepts/configuration/secret |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsServiceAccount array | List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ServiceAccount
POST /api/v1/namespaces/{namespace}/serviceaccounts
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyServiceAccount |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
| 201 ServiceAccount | Created |
| 202 ServiceAccount | Accepted |
partially update the specified ServiceAccount
PATCH /api/v1/namespaces/{namespace}/serviceaccounts/{name}
| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
replace the specified ServiceAccount
PUT /api/v1/namespaces/{namespace}/serviceaccounts/{name}
| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyServiceAccount |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
| 201 ServiceAccount | Created |
delete a ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts/{name}
| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
| 202 ServiceAccount | Accepted |
delete collection of ServiceAccount
DELETE /api/v1/namespaces/{namespace}/serviceaccounts
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts/{name}
| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ServiceAccount | OK |
list or watch objects of kind ServiceAccount
GET /api/v1/namespaces/{namespace}/serviceaccounts
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ServiceAccountList | OK |
list or watch objects of kind ServiceAccount
GET /api/v1/serviceaccounts
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ServiceAccountList | OK |
watch changes to an object of kind ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts/{name}
| Parameter | Description |
|---|---|
name | name of the ServiceAccount |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/serviceaccounts
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ServiceAccount. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/serviceaccounts
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
internal.apiserver.k8s.io | v1alpha1 | StorageVersion |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | The name is <group>.<resource>. |
specStorageVersionSpec | Spec is an empty spec. It is here to comply with Kubernetes API style. |
statusStorageVersionStatus | API server instances report the version they can decode and the version they encode objects to when persisting objects in the backend. |
| Field | Description |
|---|
| Field | Description |
|---|---|
commonEncodingVersionstring | If all API server instances agree on the same encoding storage version, then this field is set to that version. Otherwise this field is left empty. API servers should finish updating its storageVersionStatus entry before serving write operations, so that this field will be in sync with the reality. |
conditionsStorageVersionCondition array | The latest available observations of the storageVersion's state. |
storageVersionsServerStorageVersion array | The reported versions per API server instance. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsStorageVersion array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a StorageVersion
POST /apis/internal.apiserver.k8s.io/v1alpha1/storageversions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageVersion |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
| 201 StorageVersion | Created |
| 202 StorageVersion | Accepted |
partially update the specified StorageVersion
PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
replace the specified StorageVersion
PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageVersion |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
| 201 StorageVersion | Created |
delete a StorageVersion
DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of StorageVersion
DELETE /apis/internal.apiserver.k8s.io/v1alpha1/storageversions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StorageVersion
GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
list or watch objects of kind StorageVersion
GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 StorageVersionList | OK |
watch changes to an object of kind StorageVersion. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions/{name}
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StorageVersion. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/internal.apiserver.k8s.io/v1alpha1/watch/storageversions
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified StorageVersion
PATCH /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
read status of the specified StorageVersion
GET /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
replace status of the specified StorageVersion
PUT /apis/internal.apiserver.k8s.io/v1alpha1/storageversions/{name}/status
| Parameter | Description |
|---|---|
name | name of the StorageVersion |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageVersion |
| Code | Description |
|---|---|
| 200 StorageVersion | OK |
| 201 StorageVersion | Created |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1 | SubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
extraobject | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. |
groupsstring array | Groups is the groups you're testing for. |
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
uidstring | UID information about the requesting user. |
userstring | User is the user you're testing for. If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups |
| Field | Description |
|---|---|
allowedboolean | Allowed is required. True if the action would be allowed, false otherwise. |
deniedboolean | Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true. |
evaluationErrorstring | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. |
reasonstring | Reason is optional. It indicates why a request was allowed or denied. |
create a SubjectAccessReview
POST /apis/authorization.k8s.io/v1/subjectaccessreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySubjectAccessReview |
| Code | Description |
|---|---|
| 200 SubjectAccessReview | OK |
| 201 SubjectAccessReview | Created |
| 202 SubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1 | TokenRequest |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specTokenRequestSpec | |
statusTokenRequestStatus |
| Field | Description |
|---|---|
audiencesstring array | Audiences are the intendend audiences of the token. A recipient of a token must identitfy themself with an identifier in the list of audiences of the token, and otherwise should reject the token. A token issued for multiple audiences may be used to authenticate against any of the audiences listed but implies a high degree of trust between the target audiences. |
boundObjectRefBoundObjectReference | BoundObjectRef is a reference to an object that the token will be bound to. The token will only be valid for as long as the bound object exists. NOTE: The API server's TokenReview endpoint will validate the BoundObjectRef, but other audiences may not. Keep ExpirationSeconds small if you want prompt revocation. |
expirationSecondsinteger | ExpirationSeconds is the requested duration of validity of the request. The token issuer may return a token with a different validity duration so a client needs to check the 'expiration' field in a response. |
| Field | Description |
|---|---|
expirationTimestampTime | ExpirationTimestamp is the time of expiration of the returned token. |
tokenstring | Token is the opaque bearer token. |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1 | TokenReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specTokenReviewSpec | Spec holds information about the request being evaluated |
statusTokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated. |
| Field | Description |
|---|---|
audiencesstring array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. |
tokenstring | Token is the opaque bearer token. |
| Field | Description |
|---|---|
audiencesstring array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server. |
authenticatedboolean | Authenticated indicates that the token was associated with a known user. |
errorstring | Error indicates that the token couldn't be checked |
userUserInfo | User is the UserInfo associated with the provided token. |
create a TokenReview
POST /apis/authentication.k8s.io/v1/tokenreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyTokenReview |
| Code | Description |
|---|---|
| 200 TokenReview | OK |
| 201 TokenReview | Created |
| 202 TokenReview | Accepted |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1 | NetworkPolicy |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specNetworkPolicySpec | Specification of the desired behavior for this NetworkPolicy. |
| Field | Description |
|---|---|
egressNetworkPolicyEgressRule array | List of egress rules to be applied to the selected pods. Outgoing traffic is allowed if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy limits all outgoing traffic (and serves solely to ensure that the pods it selects are isolated by default). This field is beta-level in 1.8 |
ingressNetworkPolicyIngressRule array | List of ingress rules to be applied to the selected pods. Traffic is allowed to a pod if there are no NetworkPolicies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod's local node, OR if the traffic matches at least one ingress rule across all of the NetworkPolicy objects whose podSelector matches the pod. If this field is empty then this NetworkPolicy does not allow any traffic (and serves solely to ensure that the pods it selects are isolated by default) |
podSelectorLabelSelector | Selects the pods to which this NetworkPolicy object applies. The array of ingress rules is applied to any pods selected by this field. Multiple network policies can select the same set of pods. In this case, the ingress rules for each are combined additively. This field is NOT optional and follows standard label selector semantics. An empty podSelector matches all pods in this namespace. |
policyTypesstring array | List of rule types that the NetworkPolicy relates to. Valid options are "Ingress", "Egress", or "Ingress,Egress". If this field is not specified, it will default based on the existence of Ingress or Egress rules; policies that contain an Egress section are assumed to affect Egress, and all policies (whether or not they contain an Ingress section) are assumed to affect Ingress. If you want to write an egress-only policy, you must explicitly specify policyTypes [ "Egress" ]. Likewise, if you want to write a policy that specifies that no egress is allowed, you must specify a policyTypes value that include "Egress" (since such a policy would not include an Egress section and would otherwise default to just [ "Ingress" ]). This field is beta-level in 1.8 |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsNetworkPolicy array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a NetworkPolicy
POST /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
| 202 NetworkPolicy | Accepted |
partially update the specified NetworkPolicy
PATCH /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
replace the specified NetworkPolicy
PUT /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyNetworkPolicy |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
| 201 NetworkPolicy | Created |
delete a NetworkPolicy
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of NetworkPolicy
DELETE /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified NetworkPolicy
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies/{name}
| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 NetworkPolicy | OK |
list or watch objects of kind NetworkPolicy
GET /apis/networking.k8s.io/v1/namespaces/{namespace}/networkpolicies
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
list or watch objects of kind NetworkPolicy
GET /apis/networking.k8s.io/v1/networkpolicies
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 NetworkPolicyList | OK |
watch changes to an object of kind NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies/{name}
| Parameter | Description |
|---|---|
name | name of the NetworkPolicy |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1/watch/namespaces/{namespace}/networkpolicies
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of NetworkPolicy. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1/watch/networkpolicies
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
This section contains definitions for objects used in the Kubernetes APIs.
This section contains older versions of resources shown above.
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | APIService |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specAPIServiceSpec | Spec contains information for locating and communicating with a server |
statusAPIServiceStatus | Status contains derived information about an API server |
| Field | Description |
|---|---|
caBundlestring | CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used. |
groupstring | Group is the API group name this server hosts |
groupPriorityMinimuminteger | GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s |
insecureSkipTLSVerifyboolean | InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead. |
serviceServiceReference | Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. |
versionstring | Version is the API version this server hosts. For example, "v1" |
versionPriorityinteger | VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
conditionsAPIServiceCondition array patch strategy: merge patch merge key: type | Current service state of apiService. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsAPIService array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create an APIService
POST /apis/apiregistration.k8s.io/v1beta1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| 202 APIService | Accepted |
partially update the specified APIService
PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace the specified APIService
PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
delete an APIService
DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of APIService
DELETE /apis/apiregistration.k8s.io/v1beta1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified APIService
GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 APIService | OK |
list or watch objects of kind APIService
GET /apis/apiregistration.k8s.io/v1beta1/apiservices
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 APIServiceList | OK |
watch changes to an object of kind APIService. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices/{name}
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of APIService. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apiregistration.k8s.io/v1beta1/watch/apiservices
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified APIService
PATCH /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 APIService | OK |
read status of the specified APIService
GET /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 APIService | OK |
replace status of the specified APIService
PUT /apis/apiregistration.k8s.io/v1beta1/apiservices/{name}/status
| Parameter | Description |
|---|---|
name | name of the APIService |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyAPIService |
| Code | Description |
|---|---|
| 200 APIService | OK |
| 201 APIService | Created |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | APIServiceCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | Last time the condition transitioned from one status to another. |
messagestring | Human-readable message indicating details about last transition. |
reasonstring | Unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | Status is the status of the condition. Can be True, False, Unknown. |
typestring | Type is the type of the condition. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | AggregationRule |
| Field | Description |
|---|---|
clusterRoleSelectorsLabelSelector array | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | AggregationRule |
| Field | Description |
|---|---|
clusterRoleSelectorsLabelSelector array | ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | CSIDriver |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. metadata.Name indicates the name of the CSI driver that this object refers to; it MUST be the same name returned by the CSI GetPluginName() call for that driver. The driver name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), dots (.), and alphanumerics between. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specCSIDriverSpec | Specification of the CSI Driver. |
| Field | Description |
|---|---|
attachRequiredboolean | attachRequired indicates this CSI volume driver requires an attach operation (because it implements the CSI ControllerPublishVolume() method), and that the Kubernetes attach detach controller should call the attach volume interface which checks the volumeattachment status and waits until the volume is attached before proceeding to mounting. The CSI external-attacher coordinates with CSI volume driver and updates the volumeattachment status when the attach operation is complete. If the CSIDriverRegistry feature gate is enabled and the value is specified to false, the attach operation will be skipped. Otherwise the attach operation will be called. |
fsGroupPolicystring | Defines if the underlying volume supports changing ownership and permission of the volume before being mounted. Refer to the specific FSGroupPolicy values for additional details. This field is alpha-level, and is only honored by servers that enable the CSIVolumeFSGroupPolicy feature gate. |
podInfoOnMountboolean | If set to true, podInfoOnMount indicates this CSI volume driver requires additional pod information (like podName, podUID, etc.) during mount operations. If set to false, pod information will not be passed on mount. Default is false. The CSI driver specifies podInfoOnMount as part of driver deployment. If true, Kubelet will pass pod information as VolumeContext in the CSI NodePublishVolume() calls. The CSI driver is responsible for parsing and validating the information passed in as VolumeContext. The following VolumeConext will be passed if podInfoOnMount is set to true. This list might grow, but the prefix will be used. "csi.storage.k8s.io/pod.name": pod.Name "csi.storage.k8s.io/pod.namespace": pod.Namespace "csi.storage.k8s.io/pod.uid": string(pod.UID) "csi.storage.k8s.io/ephemeral": "true" iff the volume is an ephemeral inline volume defined by a CSIVolumeSource, otherwise "false" "csi.storage.k8s.io/ephemeral" is a new feature in Kubernetes 1.16. It is only required for drivers which support both the "Persistent" and "Ephemeral" VolumeLifecycleMode. Other drivers can leave pod info disabled and/or ignore this field. As Kubernetes 1.15 doesn't support this field, drivers can only support one mode when deployed on such a cluster and the deployment determines which mode that is, for example via a command line parameter of the driver. |
requiresRepublishboolean | RequiresRepublish indicates the CSI driver wants `NodePublishVolume` being periodically called to reflect any possible change in the mounted volume. This field defaults to false. Note: After a successful initial NodePublishVolume call, subsequent calls to NodePublishVolume should only update the contents of the volume. New mount points will not be seen by a running container. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled. |
storageCapacityboolean | If set to true, storageCapacity indicates that the CSI volume driver wants pod scheduling to consider the storage capacity that the driver deployment will report by creating CSIStorageCapacity objects with capacity information. The check can be enabled immediately when deploying a driver. In that case, provisioning new volumes with late binding will pause until the driver deployment has published some suitable CSIStorageCapacity object. Alternatively, the driver can be deployed with the field unset or false and it can be flipped later when storage capacity information has been published. This is an alpha field and only available when the CSIStorageCapacity feature is enabled. The default is false. |
tokenRequestsTokenRequest array | TokenRequests indicates the CSI driver needs pods' service account tokens it is mounting volume for to do necessary authentication. Kubelet will pass the tokens in VolumeContext in the CSI NodePublishVolume calls. The CSI driver should parse and validate the following VolumeContext: "csi.storage.k8s.io/serviceAccount.tokens": { "<audience>": { "token": <token>, "expirationTimestamp": <expiration timestamp in RFC3339>, }, ... } Note: Audience in each TokenRequest should be different and at most one token is empty string. To receive a new token after expiry, RequiresRepublish can be used to trigger NodePublishVolume periodically. This is an alpha feature and only available when the CSIServiceAccountToken feature is enabled. |
volumeLifecycleModesstring array | VolumeLifecycleModes defines what kind of volumes this CSI volume driver supports. The default if the list is empty is "Persistent", which is the usage defined by the CSI specification and implemented in Kubernetes via the usual PV/PVC mechanism. The other mode is "Ephemeral". In this mode, volumes are defined inline inside the pod spec with CSIVolumeSource and their lifecycle is tied to the lifecycle of that pod. A driver has to be aware of this because it is only going to get a NodePublishVolume call for such a volume. For more information about implementing this mode, see https://kubernetes-csi.github.io/docs/ephemeral-local-volumes.html A driver can support one or more of these modes and more modes may be added in the future. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCSIDriver array | items is the list of CSIDriver |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CSIDriver
POST /apis/storage.k8s.io/v1beta1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSIDriver |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 201 CSIDriver | Created |
| 202 CSIDriver | Accepted |
partially update the specified CSIDriver
PATCH /apis/storage.k8s.io/v1beta1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
replace the specified CSIDriver
PUT /apis/storage.k8s.io/v1beta1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSIDriver |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 201 CSIDriver | Created |
delete a CSIDriver
DELETE /apis/storage.k8s.io/v1beta1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
| 202 CSIDriver | Accepted |
delete collection of CSIDriver
DELETE /apis/storage.k8s.io/v1beta1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CSIDriver
GET /apis/storage.k8s.io/v1beta1/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CSIDriver | OK |
list or watch objects of kind CSIDriver
GET /apis/storage.k8s.io/v1beta1/csidrivers
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CSIDriverList | OK |
watch changes to an object of kind CSIDriver. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1beta1/watch/csidrivers/{name}
| Parameter | Description |
|---|---|
name | name of the CSIDriver |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CSIDriver. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1beta1/watch/csidrivers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | CSINode |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata.name must be the Kubernetes node name. |
specCSINodeSpec | spec is the specification of CSINode |
| Field | Description |
|---|---|
driversCSINodeDriver array patch strategy: merge patch merge key: name | drivers is a list of information of all CSI Drivers existing on a node. If all drivers in the list are uninstalled, this can become empty. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCSINode array | items is the list of CSINode |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CSINode
POST /apis/storage.k8s.io/v1beta1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSINode |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 201 CSINode | Created |
| 202 CSINode | Accepted |
partially update the specified CSINode
PATCH /apis/storage.k8s.io/v1beta1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CSINode | OK |
replace the specified CSINode
PUT /apis/storage.k8s.io/v1beta1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCSINode |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 201 CSINode | Created |
delete a CSINode
DELETE /apis/storage.k8s.io/v1beta1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 CSINode | OK |
| 202 CSINode | Accepted |
delete collection of CSINode
DELETE /apis/storage.k8s.io/v1beta1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CSINode
GET /apis/storage.k8s.io/v1beta1/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CSINode | OK |
list or watch objects of kind CSINode
GET /apis/storage.k8s.io/v1beta1/csinodes
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CSINodeList | OK |
watch changes to an object of kind CSINode. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1beta1/watch/csinodes/{name}
| Parameter | Description |
|---|---|
name | name of the CSINode |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CSINode. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1beta1/watch/csinodes
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | CSINodeDriver |
| Field | Description |
|---|---|
allocatableVolumeNodeResources | allocatable represents the volume resources of a node that are available for scheduling. |
namestring | This is the name of the CSI driver that this object refers to. This MUST be the same name returned by the CSI GetPluginName() call for that driver. |
nodeIDstring | nodeID of the node from the driver point of view. This field enables Kubernetes to communicate with storage systems that do not share the same nomenclature for nodes. For example, Kubernetes may refer to a given node as "node1", but the storage system may refer to the same node as "nodeA". When Kubernetes issues a command to the storage system to attach a volume to a specific node, it can use this field to refer to the node name using the ID that the storage system will understand, e.g. "nodeA" instead of "node1". This field is required. |
topologyKeysstring array | topologyKeys is the list of keys supported by the driver. When a driver is initialized on a cluster, it provides a set of topology keys that it understands (e.g. "company.com/zone", "company.com/region"). When a driver is initialized on a node, it provides the same topology keys along with values. Kubelet will expose these topology keys as labels on its own node object. When Kubernetes does topology aware provisioning, it can use this list to determine which labels it should retrieve from the node object and pass back to the driver. It is possible for different nodes to use different topology keys. This can be empty if driver does not support topology. |
| Group | Version | Kind |
|---|---|---|
certificates.k8s.io | v1beta1 | CertificateSigningRequest |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCertificateSigningRequestSpec | The certificate request itself and any additional information. |
statusCertificateSigningRequestStatus | Derived information about the request. |
| Field | Description |
|---|---|
extraobject | Extra information about the requesting user. See user.Info interface for details. |
groupsstring array | Group information about the requesting user. See user.Info interface for details. |
requeststring | Base64-encoded PKCS#10 CSR data |
signerNamestring | Requested signer for the request. It is a qualified name in the form: `scope-hostname.io/name`. If empty, it will be defaulted: 1. If it's a kubelet client certificate, it is assigned "kubernetes.io/kube-apiserver-client-kubelet". 2. If it's a kubelet serving certificate, it is assigned "kubernetes.io/kubelet-serving". 3. Otherwise, it is assigned "kubernetes.io/legacy-unknown". Distribution of trust for signers happens out of band. You can select on this field using `spec.signerName`. |
uidstring | UID information about the requesting user. See user.Info interface for details. |
usagesstring array | allowedUsages specifies a set of usage contexts the key will be valid for. See: https://tools.ietf.org/html/rfc5280#section-4.2.1.3 https://tools.ietf.org/html/rfc5280#section-4.2.1.12 Valid values are: "signing", "digital signature", "content commitment", "key encipherment", "key agreement", "data encipherment", "cert sign", "crl sign", "encipher only", "decipher only", "any", "server auth", "client auth", "code signing", "email protection", "s/mime", "ipsec end system", "ipsec tunnel", "ipsec user", "timestamping", "ocsp signing", "microsoft sgc", "netscape sgc" |
usernamestring | Information about the requesting user. See user.Info interface for details. |
| Field | Description |
|---|---|
certificatestring | If request was approved, the controller will place the issued certificate here. |
conditionsCertificateSigningRequestCondition array | Conditions applied to the request, such as approval or denial. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCertificateSigningRequest array | |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a CertificateSigningRequest
POST /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
| 202 CertificateSigningRequest | Accepted |
partially update the specified CertificateSigningRequest
PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace the specified CertificateSigningRequest
PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
delete a CertificateSigningRequest
DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CertificateSigningRequest
DELETE /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CertificateSigningRequest
GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
list or watch objects of kind CertificateSigningRequest
GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequestList | OK |
watch changes to an object of kind CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests/{name}
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CertificateSigningRequest. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/certificates.k8s.io/v1beta1/watch/certificatesigningrequests
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CertificateSigningRequest
PATCH /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
read status of the specified CertificateSigningRequest
GET /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
replace status of the specified CertificateSigningRequest
PUT /apis/certificates.k8s.io/v1beta1/certificatesigningrequests/{name}/status
| Parameter | Description |
|---|---|
name | name of the CertificateSigningRequest |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCertificateSigningRequest |
| Code | Description |
|---|---|
| 200 CertificateSigningRequest | OK |
| 201 CertificateSigningRequest | Created |
| Group | Version | Kind |
|---|---|---|
certificates.k8s.io | v1beta1 | CertificateSigningRequestCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | lastTransitionTime is the time the condition last transitioned from one status to another. If unset, when a new condition type is added or an existing condition's status is changed, the server defaults this to the current time. |
lastUpdateTimeTime | timestamp for the last update to this condition |
messagestring | human readable message with details about the request state |
reasonstring | brief reason for the request state |
statusstring | Status of the condition, one of True, False, Unknown. Approved, Denied, and Failed conditions may not be "False" or "Unknown". Defaults to "True". If unset, should be treated as "True". |
typestring | type of the condition. Known conditions include "Approved", "Denied", and "Failed". |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
POST /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
| 202 ClusterRole | Accepted |
partially update the specified ClusterRole
PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
delete a ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterroles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | ClusterRole |
| Field | Description |
|---|---|
aggregationRuleAggregationRule | AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this ClusterRole |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRole array | Items is a list of ClusterRoles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRole
POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
| 202 ClusterRole | Accepted |
partially update the specified ClusterRole
PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
replace the specified ClusterRole
PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRole |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
| 201 ClusterRole | Created |
delete a ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRole
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRole
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRole | OK |
list or watch objects of kind ClusterRole
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleList | OK |
watch changes to an object of kind ClusterRole. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRole |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRole. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
POST /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
| 202 ClusterRoleBinding | Accepted |
partially update the specified ClusterRoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
PUT /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1beta1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/clusterrolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | ClusterRoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsClusterRoleBinding array | Items is a list of ClusterRoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a ClusterRoleBinding
POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
| 202 ClusterRoleBinding | Accepted |
partially update the specified ClusterRoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
replace the specified ClusterRoleBinding
PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyClusterRoleBinding |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
| 201 ClusterRoleBinding | Created |
delete a ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ClusterRoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 ClusterRoleBinding | OK |
list or watch objects of kind ClusterRoleBinding
GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ClusterRoleBindingList | OK |
watch changes to an object of kind ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the ClusterRoleBinding |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ClusterRoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ContainerResourceMetricSource |
| Field | Description |
|---|---|
containerstring | container is the name of the container in the pods of the scaling target |
namestring | name is the name of the resource in question. |
targetAverageUtilizationinteger | targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. |
targetAverageValueQuantity | targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ContainerResourceMetricStatus |
| Field | Description |
|---|---|
containerstring | container is the name of the container in the pods of the scaling target |
currentAverageUtilizationinteger | currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification. |
currentAverageValueQuantity | currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification. |
namestring | name is the name of the resource in question. |
| Group | Version | Kind |
|---|---|---|
batch | v2alpha1 | CronJob |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specCronJobSpec | Specification of the desired behavior of a cron job, including the schedule. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusCronJobStatus | Current status of a cron job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
concurrencyPolicystring | Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if previous run hasn't finished yet; - "Replace": cancels currently running job and replaces it with a new one |
failedJobsHistoryLimitinteger | The number of failed finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. |
jobTemplateJobTemplateSpec | Specifies the job that will be created when executing a CronJob. |
schedulestring | The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron. |
startingDeadlineSecondsinteger | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones. |
successfulJobsHistoryLimitinteger | The number of successful finished jobs to retain. This is a pointer to distinguish between explicit zero and not specified. |
suspendboolean | This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false. |
| Field | Description |
|---|---|
activeObjectReference array | A list of pointers to currently running jobs. |
lastScheduleTimeTime | Information when was the last time the job was successfully scheduled. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCronJob array | items is the list of CronJobs. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a CronJob
POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| 202 CronJob | Accepted |
partially update the specified CronJob
PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace the specified CronJob
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
delete a CronJob
DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CronJob
DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CronJob
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
list or watch objects of kind CronJob
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
list or watch objects of kind CronJob
GET /apis/batch/v2alpha1/cronjobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CronJobList | OK |
watch changes to an object of kind CronJob. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CronJob. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/batch/v2alpha1/watch/cronjobs
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CronJob
PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CronJob | OK |
read status of the specified CronJob
GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CronJob | OK |
replace status of the specified CronJob
PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status
| Parameter | Description |
|---|---|
name | name of the CronJob |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCronJob |
| Code | Description |
|---|---|
| 200 CronJob | OK |
| 201 CronJob | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | CrossVersionObjectReference |
| Field | Description |
|---|---|
apiVersionstring | API version of the referent |
kindstring | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" |
namestring | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | CrossVersionObjectReference |
| Field | Description |
|---|---|
apiVersionstring | API version of the referent |
kindstring | Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" |
namestring | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceColumnDefinition |
| Field | Description |
|---|---|
JSONPathstring | JSONPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column. |
descriptionstring | description is a human readable description of this column. |
formatstring | format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. |
namestring | name is a human readable name for the column. |
priorityinteger | priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should be given a priority greater than 0. |
typestring | type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceConversion |
| Field | Description |
|---|---|
conversionReviewVersionsstring array | conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the versions specified in this list are supported by API server, conversion will fail for the custom resource. If a persisted Webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail. Defaults to `["v1beta1"]`. |
strategystring | strategy specifies how custom resources are converted between versions. Allowed values are: - `None`: The converter only change the apiVersion and would not touch any other field in the custom resource. - `Webhook`: API Server will call to an external webhook to do the conversion. Additional information is needed for this option. This requires spec.preserveUnknownFields to be false, and spec.conversion.webhookClientConfig to be set. |
webhookClientConfigWebhookClientConfig | webhookClientConfig is the instructions for how to call the webhook if strategy is `Webhook`. Required when `strategy` is set to `Webhook`. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinition |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specCustomResourceDefinitionSpec | spec describes how the user wants the resources to appear |
statusCustomResourceDefinitionStatus | status indicates the actual state of the CustomResourceDefinition |
| Field | Description |
|---|---|
additionalPrinterColumnsCustomResourceColumnDefinition array | additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. |
conversionCustomResourceConversion | conversion defines conversion settings for the CRD. |
groupstring | group is the API group of the defined custom resource. The custom resources are served under `/apis/<group>/...`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). |
namesCustomResourceDefinitionNames | names specify the resource and kind names for the custom resource. |
preserveUnknownFieldsboolean | preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details. |
scopestring | scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`. |
subresourcesCustomResourceSubresources | subresources specify what subresources the defined custom resource has. If present, this field configures subresources for all versions. Top-level and per-version subresources are mutually exclusive. |
validationCustomResourceValidation | validation describes the schema used for validation and pruning of the custom resource. If present, this validation schema is used to validate all versions. Top-level and per-version schemas are mutually exclusive. |
versionstring | version is the API version of the defined custom resource. The custom resources are served under `/apis/<group>/<version>/...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead. |
versionsCustomResourceDefinitionVersion array | versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10. |
| Field | Description |
|---|---|
acceptedNamesCustomResourceDefinitionNames | acceptedNames are the names that are actually being used to serve discovery. They may be different than the names in spec. |
conditionsCustomResourceDefinitionCondition array | conditions indicate state for particular aspects of a CustomResourceDefinition |
storedVersionsstring array | storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration controller can finish a migration to another version (ensuring no old objects are left in storage), and then remove the rest of the versions from this list. Versions may not be removed from `spec.versions` while they exist in this list. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsCustomResourceDefinition array | items list individual CustomResourceDefinition objects |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta |
create a CustomResourceDefinition
POST /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| 202 CustomResourceDefinition | Accepted |
partially update the specified CustomResourceDefinition
PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
delete a CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of CustomResourceDefinition
DELETE /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
list or watch objects of kind CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinitionList | OK |
watch changes to an object of kind CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions/{name}
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of CustomResourceDefinition. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/apiextensions.k8s.io/v1beta1/watch/customresourcedefinitions
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified CustomResourceDefinition
PATCH /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
read status of the specified CustomResourceDefinition
GET /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
replace status of the specified CustomResourceDefinition
PUT /apis/apiextensions.k8s.io/v1beta1/customresourcedefinitions/{name}/status
| Parameter | Description |
|---|---|
name | name of the CustomResourceDefinition |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyCustomResourceDefinition |
| Code | Description |
|---|---|
| 200 CustomResourceDefinition | OK |
| 201 CustomResourceDefinition | Created |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | lastTransitionTime last time the condition transitioned from one status to another. |
messagestring | message is a human-readable message indicating details about last transition. |
reasonstring | reason is a unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | status is the status of the condition. Can be True, False, Unknown. |
typestring | type is the type of the condition. Types include Established, NamesAccepted and Terminating. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionNames |
| Field | Description |
|---|---|
categoriesstring array | categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get all`. |
kindstring | kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the `kind` attribute in API calls. |
listKindstring | listKind is the serialized kind of the list for this resource. Defaults to "`kind`List". |
pluralstring | plural is the plural name of the resource to serve. The custom resources are served under `/apis/<group>/<version>/.../<plural>`. Must match the name of the CustomResourceDefinition (in the form `<names.plural>.<group>`). Must be all lowercase. |
shortNamesstring array | shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like `kubectl get <shortname>`. It must be all lowercase. |
singularstring | singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased `kind`. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceDefinitionVersion |
| Field | Description |
|---|---|
additionalPrinterColumnsCustomResourceColumnDefinition array | additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. Top-level and per-version columns are mutually exclusive. Per-version columns must not all be set to identical values (top-level columns should be used instead). If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used. |
deprecatedboolean | deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false. |
deprecationWarningstring | deprecationWarning overrides the default warning returned to API clients. May only be set when `deprecated` is true. The default warning indicates this version is deprecated and recommends use of the newest served version of equal or greater stability, if one exists. |
namestring | name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at `/apis/<group>/<version>/...` if `served` is true. |
schemaCustomResourceValidation | schema describes the schema used for validation and pruning of this version of the custom resource. Top-level and per-version schemas are mutually exclusive. Per-version schemas must not all be set to identical values (top-level validation schema should be used instead). |
servedboolean | served is a flag enabling/disabling this version from being served via REST APIs |
storageboolean | storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true. |
subresourcesCustomResourceSubresources | subresources specify what subresources this version of the defined custom resource have. Top-level and per-version subresources are mutually exclusive. Per-version subresources must not all be set to identical values (top-level subresources should be used instead). |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresourceScale |
| Field | Description |
|---|---|
labelSelectorPathstring | labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status` or `.spec`. Must be set to work with HorizontalPodAutoscaler. The field pointed by this JSON path must be a string field (not a complex selector struct) which contains a serialized label selector in string form. More info: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions#scale-subresource If there is no value under the given path in the custom resource, the `status.selector` value in the `/scale` subresource will default to the empty string. |
specReplicasPathstring | specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.spec`. If there is no value under the given path in the custom resource, the `/scale` subresource will return an error on GET. |
statusReplicasPathstring | statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under `.status`. If there is no value under the given path in the custom resource, the `status.replicas` value in the `/scale` subresource will default to 0. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresourceStatus |
| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceSubresources |
| Field | Description |
|---|---|
scaleCustomResourceSubresourceScale | scale indicates the custom resource should serve a `/scale` subresource that returns an `autoscaling/v1` Scale object. |
statusCustomResourceSubresourceStatus | status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2. requests to the custom resource `/status` subresource ignore changes to anything other than the `status` stanza of the object. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | CustomResourceValidation |
| Field | Description |
|---|---|
openAPIV3SchemaJSONSchemaProps | openAPIV3Schema is the OpenAPI v3 schema to use for validation and pruning. |
| Group | Version | Kind |
|---|---|---|
discovery.k8s.io | v1beta1 | EndpointPort |
| Field | Description |
|---|---|
appProtocolstring | The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and http://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol. |
namestring | The name of this port. All ports in an EndpointSlice must have a unique name. If the EndpointSlice is dervied from a Kubernetes service, this corresponds to the Service.ports[].name. Name must either be an empty string or pass DNS_LABEL validation: * must be no more than 63 characters long. * must consist of lower case alphanumeric characters or '-'. * must start and end with an alphanumeric character. Default is empty string. |
portinteger | The port number of the endpoint. If this is not specified, ports are not restricted and must be interpreted in the context of the specific consumer. |
protocolstring | The IP protocol for this port. Must be UDP, TCP, or SCTP. Default is TCP. |
| Group | Version | Kind |
|---|---|---|
core | v1 | Event |
| Field | Description |
|---|---|
actionstring | What action was taken/failed regarding to the Regarding object. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
countinteger | The number of times this event has occurred. |
eventTimeMicroTime | Time when this Event was first observed. |
firstTimestampTime | The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) |
involvedObjectObjectReference | The object that this event is about. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
lastTimestampTime | The time at which the most recent occurrence of this event was recorded. |
messagestring | A human-readable description of the status of this operation. |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
reasonstring | This should be a short, machine understandable string that gives the reason for the transition into the object's current status. |
relatedObjectReference | Optional secondary object for more complex actions. |
reportingComponentstring | Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. |
reportingInstancestring | ID of the controller instance, e.g. `kubelet-xyzf`. |
seriesEventSeries | Data about the Event series this event represents or nil if it's a singleton Event. |
sourceEventSource | The component reporting this event. Should be a short machine understandable string. |
typestring | Type of this event (Normal, Warning), new types could be added in the future |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsEvent array | List of events |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create an Event
POST /api/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
| 202 Event | Accepted |
partially update the specified Event
PATCH /api/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Event | OK |
replace the specified Event
PUT /api/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
delete an Event
DELETE /api/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Event
DELETE /api/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Event
GET /api/v1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Event | OK |
list or watch objects of kind Event
GET /api/v1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
list or watch objects of kind Event
GET /api/v1/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /api/v1/watch/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /api/v1/watch/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
events.k8s.io | v1beta1 | Event |
| Field | Description |
|---|---|
actionstring | action is what action was taken/failed regarding to the regarding object. It is machine-readable. This field can have at most 128 characters. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
deprecatedCountinteger | deprecatedCount is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedFirstTimestampTime | deprecatedFirstTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedLastTimestampTime | deprecatedLastTimestamp is the deprecated field assuring backward compatibility with core.v1 Event type. |
deprecatedSourceEventSource | deprecatedSource is the deprecated field assuring backward compatibility with core.v1 Event type. |
eventTimeMicroTime | eventTime is the time when this Event was first observed. It is required. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
notestring | note is a human-readable description of the status of this operation. Maximal length of the note is 1kB, but libraries should be prepared to handle values up to 64kB. |
reasonstring | reason is why the action was taken. It is human-readable. This field can have at most 128 characters. |
regardingObjectReference | regarding contains the object this Event is about. In most cases it's an Object reporting controller implements, e.g. ReplicaSetController implements ReplicaSets and this event is emitted because it acts on some changes in a ReplicaSet object. |
relatedObjectReference | related is the optional secondary object for more complex actions. E.g. when regarding object triggers a creation or deletion of related object. |
reportingControllerstring | reportingController is the name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. This field cannot be empty for new Events. |
reportingInstancestring | reportingInstance is the ID of the controller instance, e.g. `kubelet-xyzf`. This field cannot be empty for new Events and it can have at most 128 characters. |
seriesEventSeries | series is data about the Event series this event represents or nil if it's a singleton Event. |
typestring | type is the type of this event (Normal, Warning), new types could be added in the future. It is machine-readable. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsEvent array | items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create an Event
POST /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
| 202 Event | Accepted |
partially update the specified Event
PATCH /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Event | OK |
replace the specified Event
PUT /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyEvent |
| Code | Description |
|---|---|
| 200 Event | OK |
| 201 Event | Created |
delete an Event
DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Event
DELETE /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Event
GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Event | OK |
list or watch objects of kind Event
GET /apis/events.k8s.io/v1beta1/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
list or watch objects of kind Event
GET /apis/events.k8s.io/v1beta1/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 EventList | OK |
watch changes to an object of kind Event. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events/{name}
| Parameter | Description |
|---|---|
name | name of the Event |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/events.k8s.io/v1beta1/watch/namespaces/{namespace}/events
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Event. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/events.k8s.io/v1beta1/watch/events
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
core | v1 | EventSeries |
| Field | Description |
|---|---|
countinteger | Number of occurrences in this series up to the last heartbeat time |
lastObservedTimeMicroTime | Time of the last occurrence observed |
| Group | Version | Kind |
|---|---|---|
events.k8s.io | v1beta1 | EventSeries |
| Field | Description |
|---|---|
countinteger | count is the number of occurrences in this series up to the last heartbeat time. |
lastObservedTimeMicroTime | lastObservedTime is the time when last Event from the series was seen before last heartbeat. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | ExternalDocumentation |
| Field | Description |
|---|---|
descriptionstring | |
urlstring |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ExternalMetricSource |
| Field | Description |
|---|---|
metricNamestring | metricName is the name of the metric in question. |
metricSelectorLabelSelector | metricSelector is used to identify a specific time series within a given metric. |
targetAverageValueQuantity | targetAverageValue is the target per-pod value of global metric (as a quantity). Mutually exclusive with TargetValue. |
targetValueQuantity | targetValue is the target value of the metric (as a quantity). Mutually exclusive with TargetAverageValue. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ExternalMetricStatus |
| Field | Description |
|---|---|
currentAverageValueQuantity | currentAverageValue is the current value of metric averaged over autoscaled pods. |
currentValueQuantity | currentValue is the current value of the metric (as a quantity) |
metricNamestring | metricName is the name of a metric used for autoscaling in metric system. |
metricSelectorLabelSelector | metricSelector is used to identify a specific time series within a given metric. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | FlowDistinguisherMethod |
| Field | Description |
|---|---|
typestring | `type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | FlowSchema |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specFlowSchemaSpec | `spec` is the specification of the desired behavior of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusFlowSchemaStatus | `status` is the current status of a FlowSchema. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
distinguisherMethodFlowDistinguisherMethod | `distinguisherMethod` defines how to compute the flow distinguisher for requests that match this schema. `nil` specifies that the distinguisher is disabled and thus will always be the empty string. |
matchingPrecedenceinteger | `matchingPrecedence` is used to choose among the FlowSchemas that match a given request. The chosen FlowSchema is among those with the numerically lowest (which we take to be logically highest) MatchingPrecedence. Each MatchingPrecedence value must be ranged in [1,10000]. Note that if the precedence is not specified, it will be set to 1000 as default. |
priorityLevelConfigurationPriorityLevelConfigurationReference | `priorityLevelConfiguration` should reference a PriorityLevelConfiguration in the cluster. If the reference cannot be resolved, the FlowSchema will be ignored and marked as invalid in its status. Required. |
rulesPolicyRulesWithSubjects array | `rules` describes which requests will match this flow schema. This FlowSchema matches a request if and only if at least one member of rules matches the request. if it is an empty slice, there will be no requests matching the FlowSchema. |
| Field | Description |
|---|---|
conditionsFlowSchemaCondition array | `conditions` is a list of the current states of FlowSchema. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsFlowSchema array | `items` is a list of FlowSchemas. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | `metadata` is the standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a FlowSchema
POST /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
| 202 FlowSchema | Accepted |
partially update the specified FlowSchema
PATCH /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
replace the specified FlowSchema
PUT /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
delete a FlowSchema
DELETE /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of FlowSchema
DELETE /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
list or watch objects of kind FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 FlowSchemaList | OK |
watch changes to an object of kind FlowSchema. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/watch/flowschemas/{name}
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of FlowSchema. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/watch/flowschemas
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified FlowSchema
PATCH /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
read status of the specified FlowSchema
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
replace status of the specified FlowSchema
PUT /apis/flowcontrol.apiserver.k8s.io/v1alpha1/flowschemas/{name}/status
| Parameter | Description |
|---|---|
name | name of the FlowSchema |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyFlowSchema |
| Code | Description |
|---|---|
| 200 FlowSchema | OK |
| 201 FlowSchema | Created |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | FlowSchemaCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | `lastTransitionTime` is the last time the condition transitioned from one status to another. |
messagestring | `message` is a human-readable message indicating details about last transition. |
reasonstring | `reason` is a unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | `status` is the status of the condition. Can be True, False, Unknown. Required. |
typestring | `type` is the type of the condition. Required. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | GroupSubject |
| Field | Description |
|---|---|
namestring | name is the user group that matches, or "*" to match all user groups. See https://github.com/kubernetes/apiserver/blob/master/pkg/authentication/user/user.go for some well-known group names. Required. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | HTTPIngressPath |
| Field | Description |
|---|---|
backendIngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to. |
pathstring | Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched. |
pathTypestring | PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | HTTPIngressPath |
| Field | Description |
|---|---|
backendIngressBackend | Backend defines the referenced service endpoint to which the traffic will be forwarded to. |
pathstring | Path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a '/'. When unspecified, all paths from incoming requests are matched. |
pathTypestring | PathType determines the interpretation of the Path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by '/'. Matching is done on a path element by element basis. A path element refers is the list of labels in the path split by the '/' separator. A request is a match for path p if every p is an element-wise prefix of p of the request path. Note that if the last element of the path is a substring of the last element in request path, it is not a match (e.g. /foo/bar matches /foo/bar/baz, but does not match /foo/barbaz). * ImplementationSpecific: Interpretation of the Path matching is up to the IngressClass. Implementations can treat this as a separate PathType or treat it identically to Prefix or Exact path types. Implementations are required to support all path types. Defaults to ImplementationSpecific. |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | HTTPIngressRuleValue |
| Field | Description |
|---|---|
pathsHTTPIngressPath array | A collection of paths that map requests to backends. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | HTTPIngressRuleValue |
| Field | Description |
|---|---|
pathsHTTPIngressPath array | A collection of paths that map requests to backends. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta2 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | status is the current information about the autoscaler. |
| Field | Description |
|---|---|
behaviorHorizontalPodAutoscalerBehavior | behavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively). If not set, the default HPAScalingRules for scale up and scale down are used. |
maxReplicasinteger | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
metricsMetricSpec array | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. If not set, the default metric will be set to 80% average CPU utilization. |
minReplicasinteger | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. |
scaleTargetRefCrossVersionObjectReference | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. |
| Field | Description |
|---|---|
conditionsHorizontalPodAutoscalerCondition array | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. |
currentMetricsMetricStatus array | currentMetrics is the last read state of the metrics used by this autoscaler. |
currentReplicasinteger | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
desiredReplicasinteger | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
lastScaleTimeTime | lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed. |
observedGenerationinteger | observedGeneration is the most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | items is the list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | metadata is the standard list metadata. |
create a HorizontalPodAutoscaler
POST /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| 202 HorizontalPodAutoscaler | Accepted |
partially update the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
delete a HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta2/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v2beta2/watch/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v2beta2/watch/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta2/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | HorizontalPodAutoscaler |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | metadata is the standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specHorizontalPodAutoscalerSpec | spec is the specification for the behaviour of the autoscaler. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. |
statusHorizontalPodAutoscalerStatus | status is the current information about the autoscaler. |
| Field | Description |
|---|---|
maxReplicasinteger | maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas. |
metricsMetricSpec array | metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated multiplying the ratio between the target value and the current value by the current number of pods. Ergo, metrics used must decrease as the pod count is increased, and vice-versa. See the individual metric source types for more information about how each type of metric must respond. |
minReplicasinteger | minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available. |
scaleTargetRefCrossVersionObjectReference | scaleTargetRef points to the target resource to scale, and is used to the pods for which metrics should be collected, as well as to actually change the replica count. |
| Field | Description |
|---|---|
conditionsHorizontalPodAutoscalerCondition array | conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met. |
currentMetricsMetricStatus array | currentMetrics is the last read state of the metrics used by this autoscaler. |
currentReplicasinteger | currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler. |
desiredReplicasinteger | desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler. |
lastScaleTimeTime | lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed. |
observedGenerationinteger | observedGeneration is the most recent generation observed by this autoscaler. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsHorizontalPodAutoscaler array | items is the list of horizontal pod autoscaler objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | metadata is the standard list metadata. |
create a HorizontalPodAutoscaler
POST /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| 202 HorizontalPodAutoscaler | Accepted |
partially update the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
delete a HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of HorizontalPodAutoscaler
DELETE /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
list or watch objects of kind HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscalerList | OK |
watch changes to an object of kind HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers/{name}
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v2beta1/watch/namespaces/{namespace}/horizontalpodautoscalers
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of HorizontalPodAutoscaler. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/autoscaling/v2beta1/watch/horizontalpodautoscalers
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified HorizontalPodAutoscaler
PATCH /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
read status of the specified HorizontalPodAutoscaler
GET /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
replace status of the specified HorizontalPodAutoscaler
PUT /apis/autoscaling/v2beta1/namespaces/{namespace}/horizontalpodautoscalers/{name}/status
| Parameter | Description |
|---|---|
name | name of the HorizontalPodAutoscaler |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyHorizontalPodAutoscaler |
| Code | Description |
|---|---|
| 200 HorizontalPodAutoscaler | OK |
| 201 HorizontalPodAutoscaler | Created |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | HorizontalPodAutoscalerCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | lastTransitionTime is the last time the condition transitioned from one status to another |
messagestring | message is a human-readable explanation containing details about the transition |
reasonstring | reason is the reason for the condition's last transition. |
statusstring | status is the status of the condition (True, False, Unknown) |
typestring | type describes the current condition |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | Ingress |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specIngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusIngressStatus | Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
backendIngressBackend | A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
ingressClassNamestring | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. |
rulesIngressRule array | A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
tlsIngressTLS array | TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
| Field | Description |
|---|---|
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsIngress array | Items is the list of Ingress. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create an Ingress
POST /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| 202 Ingress | Accepted |
partially update the specified Ingress
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace the specified Ingress
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
delete an Ingress
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Ingress
DELETE /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
list or watch objects of kind Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
list or watch objects of kind Ingress
GET /apis/extensions/v1beta1/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/extensions/v1beta1/watch/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Ingress
PATCH /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
read status of the specified Ingress
GET /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace status of the specified Ingress
PUT /apis/extensions/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | Ingress |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specIngressSpec | Spec is the desired state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusIngressStatus | Status is the current state of the Ingress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
backendIngressBackend | A default backend capable of servicing requests that don't match any rule. At least one of 'backend' or 'rules' must be specified. This field is optional to allow the loadbalancer controller or defaulting logic to specify a global default. |
ingressClassNamestring | IngressClassName is the name of the IngressClass cluster resource. The associated IngressClass defines which controller will implement the resource. This replaces the deprecated `kubernetes.io/ingress.class` annotation. For backwards compatibility, when that annotation is set, it must be given precedence over this field. The controller may emit a warning if the field and annotation have different values. Implementations of this API should ignore Ingresses without a class specified. An IngressClass resource may be marked as default, which can be used to set a default value for this field. For more information, refer to the IngressClass documentation. |
rulesIngressRule array | A list of host rules used to configure the Ingress. If unspecified, or no rule matches, all traffic is sent to the default backend. |
tlsIngressTLS array | TLS configuration. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI. |
| Field | Description |
|---|---|
loadBalancerLoadBalancerStatus | LoadBalancer contains the current status of the load-balancer. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsIngress array | Items is the list of Ingress. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create an Ingress
POST /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| 202 Ingress | Accepted |
partially update the specified Ingress
PATCH /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace the specified Ingress
PUT /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
delete an Ingress
DELETE /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Ingress
DELETE /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Ingress
GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
list or watch objects of kind Ingress
GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
list or watch objects of kind Ingress
GET /apis/networking.k8s.io/v1beta1/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressList | OK |
watch changes to an object of kind Ingress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/networking.k8s.io/v1beta1/watch/namespaces/{namespace}/ingresses/{name}
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1beta1/watch/namespaces/{namespace}/ingresses
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Ingress. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1beta1/watch/ingresses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified Ingress
PATCH /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Ingress | OK |
read status of the specified Ingress
GET /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Ingress | OK |
replace status of the specified Ingress
PUT /apis/networking.k8s.io/v1beta1/namespaces/{namespace}/ingresses/{name}/status
| Parameter | Description |
|---|---|
name | name of the Ingress |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngress |
| Code | Description |
|---|---|
| 200 Ingress | OK |
| 201 Ingress | Created |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressBackend |
| Field | Description |
|---|---|
resourceTypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified. |
serviceNamestring | Specifies the name of the referenced service. |
servicePort | Specifies the port of the referenced service. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | IngressBackend |
| Field | Description |
|---|---|
resourceTypedLocalObjectReference | Resource is an ObjectRef to another Kubernetes resource in the namespace of the Ingress object. If resource is specified, serviceName and servicePort must not be specified. |
serviceNamestring | Specifies the name of the referenced service. |
servicePort | Specifies the port of the referenced service. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | IngressClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specIngressClassSpec | Spec is the desired state of the IngressClass. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
controllerstring | Controller refers to the name of the controller that should handle this class. This allows for different "flavors" that are controlled by the same controller. For example, you may have different Parameters for the same implementing controller. This should be specified as a domain-prefixed path no more than 250 characters in length, e.g. "acme.io/ingress-controller". This field is immutable. |
parametersTypedLocalObjectReference | Parameters is a link to a custom resource containing additional configuration for the controller. This is optional if the controller does not require extra parameters. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsIngressClass array | Items is the list of IngressClasses. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. |
create an IngressClass
POST /apis/networking.k8s.io/v1beta1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngressClass |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
| 201 IngressClass | Created |
| 202 IngressClass | Accepted |
partially update the specified IngressClass
PATCH /apis/networking.k8s.io/v1beta1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
replace the specified IngressClass
PUT /apis/networking.k8s.io/v1beta1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyIngressClass |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
| 201 IngressClass | Created |
delete an IngressClass
DELETE /apis/networking.k8s.io/v1beta1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of IngressClass
DELETE /apis/networking.k8s.io/v1beta1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified IngressClass
GET /apis/networking.k8s.io/v1beta1/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 IngressClass | OK |
list or watch objects of kind IngressClass
GET /apis/networking.k8s.io/v1beta1/ingressclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 IngressClassList | OK |
watch changes to an object of kind IngressClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses/{name}
| Parameter | Description |
|---|---|
name | name of the IngressClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of IngressClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/networking.k8s.io/v1beta1/watch/ingressclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressRule |
| Field | Description |
|---|---|
hoststring | Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '\*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. |
httpHTTPIngressRuleValue |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | IngressRule |
| Field | Description |
|---|---|
hoststring | Host is the fully qualified domain name of a network host, as defined by RFC 3986. Note the following deviations from the "host" part of the URI as defined in RFC 3986: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The `:` delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue. If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue. Host can be "precise" which is a domain name without the terminating dot of a network host (e.g. "foo.bar.com") or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. "*.foo.com"). The wildcard character '\*' must appear by itself as the first DNS label and matches only a single label. You cannot have a wildcard label by itself (e.g. Host == "*"). Requests will be matched against the Host field in the following way: 1. If Host is precise, the request matches this rule if the http host header is equal to Host. 2. If Host is a wildcard, then the request matches this rule if the http host header is to equal to the suffix (removing the first label) of the wildcard rule. |
httpHTTPIngressRuleValue |
| Group | Version | Kind |
|---|---|---|
extensions | v1beta1 | IngressTLS |
| Field | Description |
|---|---|
hostsstring array | Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. |
secretNamestring | SecretName is the name of the secret used to terminate SSL traffic on 443. Field is left optional to allow SSL routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |
| Group | Version | Kind |
|---|---|---|
networking.k8s.io | v1beta1 | IngressTLS |
| Field | Description |
|---|---|
hostsstring array | Hosts are a list of hosts included in the TLS certificate. The values in this list must match the name/s used in the tlsSecret. Defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress, if left unspecified. |
secretNamestring | SecretName is the name of the secret used to terminate TLS traffic on port 443. Field is left optional to allow TLS routing based on SNI hostname alone. If the SNI host in a listener conflicts with the "Host" header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSON |
| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaProps |
| Field | Description |
|---|---|
$refstring | |
$schemastring | |
additionalItemsJSONSchemaPropsOrBool | |
additionalPropertiesJSONSchemaPropsOrBool | |
allOfJSONSchemaProps array | |
anyOfJSONSchemaProps array | |
defaultJSON | default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. CustomResourceDefinitions with defaults must be created using the v1 (or newer) CustomResourceDefinition API. |
definitionsobject | |
dependenciesobject | |
descriptionstring | |
enumJSON array | |
exampleJSON | |
exclusiveMaximumboolean | |
exclusiveMinimumboolean | |
externalDocsExternalDocumentation | |
formatstring | format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by Golang net/url.ParseRequestURI - email: an email address as parsed by Golang net/mail.ParseAddress - hostname: a valid representation for an Internet host name, as defined by RFC 1034, section 3.1 [RFC1034]. - ipv4: an IPv4 IP as parsed by Golang net.ParseIP - ipv6: an IPv6 IP as parsed by Golang net.ParseIP - cidr: a CIDR as parsed by Golang net.ParseCIDR - mac: a MAC address as parsed by Golang net.ParseMAC - uuid: an UUID that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid3: an UUID3 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?3[0-9a-f]{3}-?[0-9a-f]{4}-?[0-9a-f]{12}$ - uuid4: an UUID4 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?4[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - uuid5: an UUID5 that allows uppercase defined by the regex (?i)^[0-9a-f]{8}-?[0-9a-f]{4}-?5[0-9a-f]{3}-?[89ab][0-9a-f]{3}-?[0-9a-f]{12}$ - isbn: an ISBN10 or ISBN13 number string like "0321751043" or "978-0321751041" - isbn10: an ISBN10 number string like "0321751043" - isbn13: an ISBN13 number string like "978-0321751041" - creditcard: a credit card number defined by the regex ^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6(?:011|5[0-9][0-9])[0-9]{12}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|(?:2131|1800|35\d{3})\d{11})$ with any non digit characters mixed in - ssn: a U.S. social security number following the regex ^\d{3}[- ]?\d{2}[- ]?\d{4}$ - hexcolor: an hexadecimal color code like "#FFFFFF: following the regex ^#?([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ - rgbcolor: an RGB color code like rgb like "rgb(255,255,2559" - byte: base64 encoded binary data - password: any kind of string - date: a date string like "2006-01-02" as defined by full-date in RFC3339 - duration: a duration string like "22 ns" as parsed by Golang time.ParseDuration or compatible with Scala duration format - datetime: a date time string like "2014-12-15T19:30:20.000Z" as defined by date-time in RFC3339. |
idstring | |
itemsJSONSchemaPropsOrArray | |
maxItemsinteger | |
maxLengthinteger | |
maxPropertiesinteger | |
maximumnumber | |
minItemsinteger | |
minLengthinteger | |
minPropertiesinteger | |
minimumnumber | |
multipleOfnumber | |
notJSONSchemaProps | |
nullableboolean | |
oneOfJSONSchemaProps array | |
patternstring | |
patternPropertiesobject | |
propertiesobject | |
requiredstring array | |
titlestring | |
typestring | |
uniqueItemsboolean | |
x-kubernetes-embedded-resourceboolean | x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded object. kind, apiVersion and metadata are validated automatically. x-kubernetes-preserve-unknown-fields is allowed to be true, but does not have to be if the object is fully specified (up to kind, apiVersion, metadata). |
x-kubernetes-int-or-stringboolean | x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the following patterns: 1) anyOf: - type: integer - type: string 2) allOf: - anyOf: - type: integer - type: string - ... zero or more |
x-kubernetes-list-map-keysstring array | x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the "x-kubernetes-list-type" extension set to "map". Also, the values specified for this attribute must be a scalar typed field of the child structure (no nesting is supported). The properties specified must either be required or have a default value, to ensure those properties are present for all list items. |
x-kubernetes-list-typestring | x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single entity, like a scalar. Atomic lists will be entirely replaced when updated. This extension may be used on any type of list (struct, scalar, ...). 2) `set`: Sets are lists that must not have multiple items with the same value. Each value must be a scalar, an object with x-kubernetes-map-type `atomic` or an array with x-kubernetes-list-type `atomic`. 3) `map`: These lists are like maps in that their elements have a non-index key used to identify them. Order is preserved upon merge. The map tag must only be used on a list with elements of type object. Defaults to atomic for arrays. |
x-kubernetes-map-typestring | x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are actual maps (key-value pairs) and each fields are independent from each other (they can each be manipulated by separate actors). This is the default behaviour for all maps. 2) `atomic`: the list is treated as a single entity, like a scalar. Atomic maps will be entirely replaced when updated. |
x-kubernetes-preserve-unknown-fieldsboolean | x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to normal pruning behaviour if nested properties or additionalProperties are specified in the schema. This can either be true or undefined. False is forbidden. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaPropsOrArray |
| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | JSONSchemaPropsOrBool |
| Field | Description |
|---|
| Group | Version | Kind |
|---|---|---|
batch | v2alpha1 | JobTemplateSpec |
| Field | Description |
|---|---|
metadataObjectMeta | Standard object's metadata of the jobs created from this template. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specJobSpec | Specification of the desired behavior of the job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Group | Version | Kind |
|---|---|---|
coordination.k8s.io | v1beta1 | Lease |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specLeaseSpec | Specification of the Lease. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
acquireTimeMicroTime | acquireTime is a time when the current lease was acquired. |
holderIdentitystring | holderIdentity contains the identity of the holder of a current lease. |
leaseDurationSecondsinteger | leaseDurationSeconds is a duration that candidates for a lease need to wait to force acquire it. This is measure against time of last observed RenewTime. |
leaseTransitionsinteger | leaseTransitions is the number of transitions of a lease between holders. |
renewTimeMicroTime | renewTime is a time when the current holder of a lease has last updated the lease. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsLease array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a Lease
POST /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLease |
| Code | Description |
|---|---|
| 200 Lease | OK |
| 201 Lease | Created |
| 202 Lease | Accepted |
partially update the specified Lease
PATCH /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Lease | OK |
replace the specified Lease
PUT /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyLease |
| Code | Description |
|---|---|
| 200 Lease | OK |
| 201 Lease | Created |
delete a Lease
DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Lease
DELETE /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Lease
GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 Lease | OK |
list or watch objects of kind Lease
GET /apis/coordination.k8s.io/v1beta1/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LeaseList | OK |
list or watch objects of kind Lease
GET /apis/coordination.k8s.io/v1beta1/leases
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 LeaseList | OK |
watch changes to an object of kind Lease. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases/{name}
| Parameter | Description |
|---|---|
name | name of the Lease |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/coordination.k8s.io/v1beta1/watch/namespaces/{namespace}/leases
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Lease. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/coordination.k8s.io/v1beta1/watch/leases
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | LimitResponse |
| Field | Description |
|---|---|
queuingQueuingConfiguration | `queuing` holds the configuration parameters for queuing. This field may be non-empty only if `type` is `"Queue"`. |
typestring | `type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means that requests that can not be executed upon arrival are rejected. Required. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | LimitedPriorityLevelConfiguration |
| Field | Description |
|---|---|
assuredConcurrencySharesinteger | `assuredConcurrencyShares` (ACS) configures the execution limit, which is a limit on the number of requests of this priority level that may be exeucting at a given time. ACS must be a positive number. The server's concurrency limit (SCL) is divided among the concurrency-controlled priority levels in proportion to their assured concurrency shares. This produces the assured concurrency value (ACV) --- the number of requests that may be executing at a time --- for each such priority level: ACV(l) = ceil( SCL * ACS(l) / ( sum[priority levels k] ACS(k) ) ) bigger numbers of ACS mean more reserved concurrent requests (at the expense of every other PL). This field has a default value of 30. |
limitResponseLimitResponse | `limitResponse` indicates what to do with requests that can not be executed right now |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | LocalSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated. spec.namespace must be equal to the namespace you made the request against. If empty, it is defaulted. |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
create a LocalSubjectAccessReview
POST /apis/authorization.k8s.io/v1beta1/namespaces/{namespace}/localsubjectaccessreviews
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyLocalSubjectAccessReview |
| Code | Description |
|---|---|
| 200 LocalSubjectAccessReview | OK |
| 201 LocalSubjectAccessReview | Created |
| 202 LocalSubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | MetricSpec |
| Field | Description |
|---|---|
containerResourceContainerResourceMetricSource | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod of the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. This is an alpha feature and can be enabled by the HPAContainerMetrics feature flag. |
externalExternalMetricSource | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricSource | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricSource | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricSource | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | MetricStatus |
| Field | Description |
|---|---|
containerResourceContainerResourceMetricStatus | container resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
externalExternalMetricStatus | external refers to a global metric that is not associated with any Kubernetes object. It allows autoscaling based on information coming from components running outside of cluster (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster). |
objectObjectMetricStatus | object refers to a metric describing a single kubernetes object (for example, hits-per-second on an Ingress object). |
podsPodsMetricStatus | pods refers to a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value. |
resourceResourceMetricStatus | resource refers to a resource metric (such as those specified in requests and limits) known to Kubernetes describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. |
typestring | type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object. Note: "ContainerResource" type is available on when the feature-gate HPAContainerMetrics is enabled |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | MutatingWebhook |
| Field | Description |
|---|---|
admissionReviewVersionsstring array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. |
clientConfigWebhookClientConfig | ClientConfig defines how to communicate with the hook. Required |
failurePolicystring | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. |
matchPolicystring | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact" |
namestring | The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. |
namespaceSelectorLabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more examples of label selectors. Default to the empty LabelSelector, which matches everything. |
objectSelectorLabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. |
reinvocationPolicystring | reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not be called more than once in a single admission evaluation. IfNeeded: the webhook will be called at least one additional time as part of the admission evaluation if the object being admitted is modified by other admission plugins after the initial webhook call. Webhooks that specify this option *must* be idempotent, able to process objects they previously admitted. Note: * the number of additional invocations is not guaranteed to be exactly one. * if additional invocations result in further modifications to the object, webhooks are not guaranteed to be invoked again. * webhooks that use this option may be reordered to minimize the number of additional invocations. * to validate an object after all mutations are guaranteed complete, use a validating admission webhook instead. Defaults to "Never". |
rulesRuleWithOperations array | Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. |
sideEffectsstring | SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. |
timeoutSecondsinteger | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | MutatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
webhooksMutatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsMutatingWebhookConfiguration array | List of MutatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a MutatingWebhookConfiguration
POST /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
| 202 MutatingWebhookConfiguration | Accepted |
partially update the specified MutatingWebhookConfiguration
PATCH /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
replace the specified MutatingWebhookConfiguration
PUT /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyMutatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
| 201 MutatingWebhookConfiguration | Created |
delete a MutatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of MutatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified MutatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfiguration | OK |
list or watch objects of kind MutatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1beta1/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 MutatingWebhookConfigurationList | OK |
watch changes to an object of kind MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the MutatingWebhookConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of MutatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/admissionregistration.k8s.io/v1beta1/watch/mutatingwebhookconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | NonResourceAttributes |
| Field | Description |
|---|---|
pathstring | Path is the URL path of the request |
verbstring | Verb is the standard HTTP verb |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | NonResourcePolicyRule |
| Field | Description |
|---|---|
nonResourceURLsstring array | `nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches nothing - "/hea/*" also matches nothing - "/healthz/*" matches all per-component health checks. "*" matches all non-resource urls. if it is present, it must be the only entry. Required. |
verbsstring array | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | NonResourceRule |
| Field | Description |
|---|---|
nonResourceURLsstring array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path. "*" means all. |
verbsstring array | Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ObjectMetricSource |
| Field | Description |
|---|---|
averageValueQuantity | averageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
metricNamestring | metricName is the name of the metric in question. |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. |
targetCrossVersionObjectReference | target is the described Kubernetes object. |
targetValueQuantity | targetValue is the target value of the metric (as a quantity). |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ObjectMetricStatus |
| Field | Description |
|---|---|
averageValueQuantity | averageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
currentValueQuantity | currentValue is the current value of the metric (as a quantity). |
metricNamestring | metricName is the name of the metric in question. |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the ObjectMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. |
targetCrossVersionObjectReference | target is the described Kubernetes object. |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1beta1 | Overhead |
| Field | Description |
|---|---|
podFixedobject | PodFixed represents the fixed resource overhead associated with running a pod. |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1alpha1 | Overhead |
| Field | Description |
|---|---|
podFixedobject | PodFixed represents the fixed resource overhead associated with running a pod. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | PodsMetricSource |
| Field | Description |
|---|---|
metricNamestring | metricName is the name of the metric in question |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set, it is passed as an additional parameter to the metrics server for more specific metrics scoping When unset, just the metricName will be used to gather metrics. |
targetAverageValueQuantity | targetAverageValue is the target value of the average of the metric across all relevant pods (as a quantity) |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | PodsMetricStatus |
| Field | Description |
|---|---|
currentAverageValueQuantity | currentAverageValue is the current value of the average of the metric across all relevant pods (as a quantity) |
metricNamestring | metricName is the name of the metric in question |
selectorLabelSelector | selector is the string-encoded form of a standard kubernetes label selector for the given metric When set in the PodsMetricSource, it is passed as an additional parameter to the metrics server for more specific metrics scoping. When unset, just the metricName will be used to gather metrics. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | PolicyRule |
| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. |
nonResourceURLsstring array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
resourcesstring array | Resources is a list of resources this rule applies to. '\*' represents all resources in the specified apiGroups. '\*/foo' represents the subresource 'foo' for all resources in the specified apiGroups. |
verbsstring array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | PolicyRule |
| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. |
nonResourceURLsstring array | NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as "pods" or "secrets") or non-resource URL paths (such as "/api"), but not both. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. |
resourcesstring array | Resources is a list of resources this rule applies to. ResourceAll represents all resources. |
verbsstring array | Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | PolicyRulesWithSubjects |
| Field | Description |
|---|---|
nonResourceRulesNonResourcePolicyRule array | `nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL. |
resourceRulesResourcePolicyRule array | `resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be non-empty. |
subjectsSubject array | subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and system:unauthenticated user groups matches every request. Required. |
| Group | Version | Kind |
|---|---|---|
scheduling.k8s.io | v1beta1 | PriorityClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
descriptionstring | description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefaultboolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
preemptionPolicystring | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
valueinteger | The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPriorityClass array | items is the list of PriorityClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PriorityClass
POST /apis/scheduling.k8s.io/v1beta1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
| 202 PriorityClass | Accepted |
partially update the specified PriorityClass
PATCH /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
replace the specified PriorityClass
PUT /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
delete a PriorityClass
DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityClass
DELETE /apis/scheduling.k8s.io/v1beta1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityClass
GET /apis/scheduling.k8s.io/v1beta1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
list or watch objects of kind PriorityClass
GET /apis/scheduling.k8s.io/v1beta1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PriorityClassList | OK |
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/scheduling.k8s.io/v1beta1/watch/priorityclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
scheduling.k8s.io | v1alpha1 | PriorityClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
descriptionstring | description is an arbitrary string that usually provides guidelines on when this priority class should be used. |
globalDefaultboolean | globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as `globalDefault`. However, if more than one PriorityClasses exists with their `globalDefault` field set to true, the smallest value of such global default PriorityClasses will be used as the default priority. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
preemptionPolicystring | PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate. |
valueinteger | The value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPriorityClass array | items is the list of PriorityClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PriorityClass
POST /apis/scheduling.k8s.io/v1alpha1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
| 202 PriorityClass | Accepted |
partially update the specified PriorityClass
PATCH /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
replace the specified PriorityClass
PUT /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityClass |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
| 201 PriorityClass | Created |
delete a PriorityClass
DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityClass
DELETE /apis/scheduling.k8s.io/v1alpha1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityClass
GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PriorityClass | OK |
list or watch objects of kind PriorityClass
GET /apis/scheduling.k8s.io/v1alpha1/priorityclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PriorityClassList | OK |
watch changes to an object of kind PriorityClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/scheduling.k8s.io/v1alpha1/watch/priorityclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | PriorityLevelConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specPriorityLevelConfigurationSpec | `spec` is the specification of the desired behavior of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
statusPriorityLevelConfigurationStatus | `status` is the current status of a "request-priority". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
limitedLimitedPriorityLevelConfiguration | `limited` specifies how requests are handled for a Limited priority level. This field must be non-empty if and only if `type` is `"Limited"`. |
typestring | `type` indicates whether this priority level is subject to limitation on request execution. A value of `"Exempt"` means that requests of this priority level are not subject to a limit (and thus are never queued) and do not detract from the capacity made available to other priority levels. A value of `"Limited"` means that (a) requests of this priority level _are_ subject to limits and (b) some of the server's limited capacity is made available exclusively to this priority level. Required. |
| Field | Description |
|---|---|
conditionsPriorityLevelConfigurationCondition array | `conditions` is the current state of "request-priority". |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsPriorityLevelConfiguration array | `items` is a list of request-priorities. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | `metadata` is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a PriorityLevelConfiguration
POST /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
| 202 PriorityLevelConfiguration | Accepted |
partially update the specified PriorityLevelConfiguration
PATCH /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
replace the specified PriorityLevelConfiguration
PUT /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
delete a PriorityLevelConfiguration
DELETE /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of PriorityLevelConfiguration
DELETE /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
list or watch objects of kind PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfigurationList | OK |
watch changes to an object of kind PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/watch/prioritylevelconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of PriorityLevelConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/watch/prioritylevelconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
partially update status of the specified PriorityLevelConfiguration
PATCH /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
read status of the specified PriorityLevelConfiguration
GET /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
replace status of the specified PriorityLevelConfiguration
PUT /apis/flowcontrol.apiserver.k8s.io/v1alpha1/prioritylevelconfigurations/{name}/status
| Parameter | Description |
|---|---|
name | name of the PriorityLevelConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyPriorityLevelConfiguration |
| Code | Description |
|---|---|
| 200 PriorityLevelConfiguration | OK |
| 201 PriorityLevelConfiguration | Created |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | PriorityLevelConfigurationCondition |
| Field | Description |
|---|---|
lastTransitionTimeTime | `lastTransitionTime` is the last time the condition transitioned from one status to another. |
messagestring | `message` is a human-readable message indicating details about last transition. |
reasonstring | `reason` is a unique, one-word, CamelCase reason for the condition's last transition. |
statusstring | `status` is the status of the condition. Can be True, False, Unknown. Required. |
typestring | `type` is the type of the condition. Required. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | PriorityLevelConfigurationReference |
| Field | Description |
|---|---|
namestring | `name` is the name of the priority level configuration being referenced Required. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | QueuingConfiguration |
| Field | Description |
|---|---|
handSizeinteger | `handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is hashed and the hash value is used to shuffle the list of queues and deal a hand of the size specified here. The request is put into one of the shortest queues in that hand. `handSize` must be no larger than `queues`, and should be significantly smaller (so that a few heavy flows do not saturate most of the queues). See the user-facing documentation for more extensive guidance on setting this field. This field has a default value of 8. |
queueLengthLimitinteger | `queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not specified, it will be defaulted to 50. |
queuesinteger | `queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus makes the distinguisher method of associated flow schemas irrelevant. This field has a default value of 64. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | ResourceAttributes |
| Field | Description |
|---|---|
groupstring | Group is the API Group of the Resource. "*" means all. |
namestring | Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all. |
namespacestring | Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews "" (empty) is empty for cluster-scoped resources "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview |
resourcestring | Resource is one of the existing resource types. "*" means all. |
subresourcestring | Subresource is one of the existing resource types. "" means none. |
verbstring | Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all. |
versionstring | Version is the API Version of the Resource. "*" means all. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ResourceMetricSource |
| Field | Description |
|---|---|
namestring | name is the name of the resource in question. |
targetAverageUtilizationinteger | targetAverageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. |
targetAverageValueQuantity | targetAverageValue is the target value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. |
| Group | Version | Kind |
|---|---|---|
autoscaling | v2beta1 | ResourceMetricStatus |
| Field | Description |
|---|---|
currentAverageUtilizationinteger | currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. It will only be present if `targetAverageValue` was set in the corresponding metric specification. |
currentAverageValueQuantity | currentAverageValue is the current value of the average of the resource metric across all relevant pods, as a raw value (instead of as a percentage of the request), similar to the "pods" metric source type. It will always be set, regardless of the corresponding metric specification. |
namestring | name is the name of the resource in question. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | ResourcePolicyRule |
| Field | Description |
|---|---|
apiGroupsstring array | `apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required. |
clusterScopeboolean | `clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the `namespaces` field must contain a non-empty list. |
namespacesstring array | `namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the `clusterScope` field for that). This list may be empty, but only if `clusterScope` is true. |
resourcesstring array | `resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required. |
verbsstring array | `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | ResourceRule |
| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed. "*" means all. |
resourceNamesstring array | ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all. |
resourcesstring array | Resources is a list of resources this rule applies to. "*" means all in the specified apiGroups. "*/foo" represents the subresource 'foo' for all resources in the specified apiGroups. |
verbsstring array | Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
| 202 Role | Accepted |
partially update the specified Role
PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
delete a Role
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1beta1/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
rulesPolicyRule array | Rules holds all the PolicyRules for this Role |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRole array | Items is a list of Roles |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a Role
POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
| 202 Role | Accepted |
partially update the specified Role
PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 Role | OK |
replace the specified Role
PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRole |
| Code | Description |
|---|---|
| 200 Role | OK |
| 201 Role | Created |
delete a Role
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of Role
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified Role
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 Role | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
list or watch objects of kind Role
GET /apis/rbac.authorization.k8s.io/v1alpha1/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleList | OK |
watch changes to an object of kind Role. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles/{name}
| Parameter | Description |
|---|---|
name | name of the Role |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/roles
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of Role. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/roles
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
POST /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
PUT /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1beta1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1beta1/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1beta1/watch/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | RoleBinding |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. |
roleRefRoleRef | RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error. |
subjectsSubject array | Subjects holds references to the objects the role applies to. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRoleBinding array | Items is a list of RoleBindings |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard object's metadata. |
create a RoleBinding
POST /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
| 202 RoleBinding | Accepted |
partially update the specified RoleBinding
PATCH /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
replace the specified RoleBinding
PUT /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRoleBinding |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
| 201 RoleBinding | Created |
delete a RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RoleBinding
DELETE /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RoleBinding
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
| Code | Description |
|---|---|
| 200 RoleBinding | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1alpha1/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
list or watch objects of kind RoleBinding
GET /apis/rbac.authorization.k8s.io/v1alpha1/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RoleBindingList | OK |
watch changes to an object of kind RoleBinding. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings/{name}
| Parameter | Description |
|---|---|
name | name of the RoleBinding |
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/namespaces/{namespace}/rolebindings
| Parameter | Description |
|---|---|
namespace | object name and auth scope, such as for teams and projects |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RoleBinding. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/rolebindings
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | RoleRef |
| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | RoleRef |
| Field | Description |
|---|---|
apiGroupstring | APIGroup is the group for the resource being referenced |
kindstring | Kind is the type of resource being referenced |
namestring | Name is the name of resource being referenced |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | RuleWithOperations |
| Field | Description |
|---|---|
apiGroupsstring array | APIGroups is the API groups the resources belong to. '\*' is all groups. If '\*' is present, the length of the slice must be one. Required. |
apiVersionsstring array | APIVersions is the API versions the resources belong to. '\*' is all versions. If '\*' is present, the length of the slice must be one. Required. |
operationsstring array | Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '\*' is present, the length of the slice must be one. Required. |
resourcesstring array | Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '\*' means all resources, but not subresources. 'pods/\*' means all subresources of pods. '\*/scale' means all scale subresources. '\*/\*' means all resources and their subresources. If wildcard is present, the validation rule will ensure resources do not overlap with each other. Depending on the enclosing object, subresources might not be allowed. Required. |
scopestring | scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are cluster-scoped. "Namespaced" means that only namespaced resources will match this rule. "*" means that there are no scope restrictions. Subresources match the scope of their parent resource. Default is "*". |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1beta1 | RuntimeClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
handlerstring | Handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
overheadOverhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. |
schedulingScheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRuntimeClass array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a RuntimeClass
POST /apis/node.k8s.io/v1beta1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
| 202 RuntimeClass | Accepted |
partially update the specified RuntimeClass
PATCH /apis/node.k8s.io/v1beta1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
replace the specified RuntimeClass
PUT /apis/node.k8s.io/v1beta1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
delete a RuntimeClass
DELETE /apis/node.k8s.io/v1beta1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RuntimeClass
DELETE /apis/node.k8s.io/v1beta1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RuntimeClass
GET /apis/node.k8s.io/v1beta1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
list or watch objects of kind RuntimeClass
GET /apis/node.k8s.io/v1beta1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RuntimeClassList | OK |
watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/node.k8s.io/v1beta1/watch/runtimeclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1alpha1 | RuntimeClass |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specRuntimeClassSpec | Specification of the RuntimeClass More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |
| Field | Description |
|---|---|
overheadOverhead | Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature. |
runtimeHandlerstring | RuntimeHandler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is assumed that all handlers are available on every node, and handlers of the same name are equivalent on every node. For example, a handler called "runc" might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123) requirements, and is immutable. |
schedulingScheduling | Scheduling holds the scheduling constraints to ensure that pods running with this RuntimeClass are scheduled to nodes that support it. If scheduling is nil, this RuntimeClass is assumed to be supported by all nodes. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsRuntimeClass array | Items is a list of schema objects. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a RuntimeClass
POST /apis/node.k8s.io/v1alpha1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
| 202 RuntimeClass | Accepted |
partially update the specified RuntimeClass
PATCH /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
replace the specified RuntimeClass
PUT /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyRuntimeClass |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
| 201 RuntimeClass | Created |
delete a RuntimeClass
DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of RuntimeClass
DELETE /apis/node.k8s.io/v1alpha1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified RuntimeClass
GET /apis/node.k8s.io/v1alpha1/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 RuntimeClass | OK |
list or watch objects of kind RuntimeClass
GET /apis/node.k8s.io/v1alpha1/runtimeclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 RuntimeClassList | OK |
watch changes to an object of kind RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses/{name}
| Parameter | Description |
|---|---|
name | name of the RuntimeClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of RuntimeClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/node.k8s.io/v1alpha1/watch/runtimeclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1beta1 | Scheduling |
| Field | Description |
|---|---|
nodeSelectorobject | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. |
tolerationsToleration array | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. |
| Group | Version | Kind |
|---|---|---|
node.k8s.io | v1alpha1 | Scheduling |
| Field | Description |
|---|---|
nodeSelectorobject | nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass nodeSelector is merged with a pod's existing nodeSelector. Any conflicts will cause the pod to be rejected in admission. |
tolerationsToleration array | tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SelfSubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectAccessReviewSpec | Spec holds information about the request being evaluated. user and groups must be empty |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
create a SelfSubjectAccessReview
POST /apis/authorization.k8s.io/v1beta1/selfsubjectaccessreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectAccessReview |
| Code | Description |
|---|---|
| 200 SelfSubjectAccessReview | OK |
| 201 SelfSubjectAccessReview | Created |
| 202 SelfSubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SelfSubjectRulesReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSelfSubjectRulesReviewSpec | Spec holds information about the request being evaluated. |
statusSubjectRulesReviewStatus | Status is filled in by the server and indicates the set of actions a user can perform. |
| Field | Description |
|---|---|
namespacestring | Namespace to evaluate rules for. Required. |
create a SelfSubjectRulesReview
POST /apis/authorization.k8s.io/v1beta1/selfsubjectrulesreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySelfSubjectRulesReview |
| Code | Description |
|---|---|
| 200 SelfSubjectRulesReview | OK |
| 201 SelfSubjectRulesReview | Created |
| 202 SelfSubjectRulesReview | Accepted |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | ServiceAccountSubject |
| Field | Description |
|---|---|
namestring | `name` is the name of matching ServiceAccount objects, or "*" to match regardless of name. Required. |
namespacestring | `namespace` is the namespace of matching ServiceAccount objects. Required. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1 | ServiceReference |
| Field | Description |
|---|---|
namestring | name is the name of the service. Required |
namespacestring | namespace is the namespace of the service. Required |
pathstring | path is an optional URL path at which the webhook will be contacted. |
portinteger | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility. |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1 | ServiceReference |
| Field | Description |
|---|---|
namestring | Name is the name of the service |
namespacestring | Namespace is the namespace of the service |
portinteger | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | `name` is the name of the service. Required |
namespacestring | `namespace` is the namespace of the service. Required |
pathstring | `path` is an optional URL path which will be sent in any request to this service. |
portinteger | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | name is the name of the service. Required |
namespacestring | namespace is the namespace of the service. Required |
pathstring | path is an optional URL path at which the webhook will be contacted. |
portinteger | port is an optional service port at which the webhook will be contacted. `port` should be a valid port number (1-65535, inclusive). Defaults to 443 for backward compatibility. |
| Group | Version | Kind |
|---|---|---|
apiregistration.k8s.io | v1beta1 | ServiceReference |
| Field | Description |
|---|---|
namestring | Name is the name of the service |
namespacestring | Namespace is the namespace of the service |
portinteger | If specified, the port on the service that hosting webhook. Default to 443 for backward compatibility. `port` should be a valid port number (1-65535, inclusive). |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | StorageClass |
| Field | Description |
|---|---|
allowVolumeExpansionboolean | AllowVolumeExpansion shows whether the storage class allow volume expand |
allowedTopologiesTopologySelectorTerm array | Restrict the node topologies where volumes can be dynamically provisioned. Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature. |
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
mountOptionsstring array | Dynamically provisioned PersistentVolumes of this storage class are created with these mountOptions, e.g. ["ro", "soft"]. Not validated - mount of the PVs will simply fail if one is invalid. |
parametersobject | Parameters holds the parameters for the provisioner that should create volumes of this storage class. |
provisionerstring | Provisioner indicates the type of the provisioner. |
reclaimPolicystring | Dynamically provisioned PersistentVolumes of this storage class are created with this reclaimPolicy. Defaults to Delete. |
volumeBindingModestring | VolumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound. When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsStorageClass array | Items is the list of StorageClasses |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a StorageClass
POST /apis/storage.k8s.io/v1beta1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
| 202 StorageClass | Accepted |
partially update the specified StorageClass
PATCH /apis/storage.k8s.io/v1beta1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
replace the specified StorageClass
PUT /apis/storage.k8s.io/v1beta1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyStorageClass |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 201 StorageClass | Created |
delete a StorageClass
DELETE /apis/storage.k8s.io/v1beta1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
| 202 StorageClass | Accepted |
delete collection of StorageClass
DELETE /apis/storage.k8s.io/v1beta1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified StorageClass
GET /apis/storage.k8s.io/v1beta1/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 StorageClass | OK |
list or watch objects of kind StorageClass
GET /apis/storage.k8s.io/v1beta1/storageclasses
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 StorageClassList | OK |
watch changes to an object of kind StorageClass. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses/{name}
| Parameter | Description |
|---|---|
name | name of the StorageClass |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of StorageClass. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1beta1/watch/storageclasses
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1 | Subject |
| Field | Description |
|---|---|
apiGroupstring | APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. |
kindstring | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. |
namestring | Name of the object being referenced. |
namespacestring | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1beta1 | Subject |
| Field | Description |
|---|---|
apiGroupstring | APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects. |
kindstring | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. |
namestring | Name of the object being referenced. |
namespacestring | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | Subject |
| Field | Description |
|---|---|
groupGroupSubject | |
kindstring | Required |
serviceAccountServiceAccountSubject | |
userUserSubject |
| Group | Version | Kind |
|---|---|---|
rbac.authorization.k8s.io | v1alpha1 | Subject |
| Field | Description |
|---|---|
apiVersionstring | APIVersion holds the API group and version of the referenced subject. Defaults to "v1" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io/v1alpha1" for User and Group subjects. |
kindstring | Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error. |
namestring | Name of the object being referenced. |
namespacestring | Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error. |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SubjectAccessReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specSubjectAccessReviewSpec | Spec holds information about the request being evaluated |
statusSubjectAccessReviewStatus | Status is filled in by the server and indicates whether the request is allowed or not |
| Field | Description |
|---|---|
extraobject | Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer it needs a reflection here. |
groupstring array | Groups is the groups you're testing for. |
nonResourceAttributesNonResourceAttributes | NonResourceAttributes describes information for a non-resource access request |
resourceAttributesResourceAttributes | ResourceAuthorizationAttributes describes information for a resource access request |
uidstring | UID information about the requesting user. |
userstring | User is the user you're testing for. If you specify "User" but not "Group", then is it interpreted as "What if User were not a member of any groups |
| Field | Description |
|---|---|
allowedboolean | Allowed is required. True if the action would be allowed, false otherwise. |
deniedboolean | Denied is optional. True if the action would be denied, otherwise false. If both allowed is false and denied is false, then the authorizer has no opinion on whether to authorize the action. Denied may not be true if Allowed is true. |
evaluationErrorstring | EvaluationError is an indication that some error occurred during the authorization check. It is entirely possible to get an error and be able to continue determine authorization status in spite of it. For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request. |
reasonstring | Reason is optional. It indicates why a request was allowed or denied. |
create a SubjectAccessReview
POST /apis/authorization.k8s.io/v1beta1/subjectaccessreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodySubjectAccessReview |
| Code | Description |
|---|---|
| 200 SubjectAccessReview | OK |
| 201 SubjectAccessReview | Created |
| 202 SubjectAccessReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authorization.k8s.io | v1beta1 | SubjectRulesReviewStatus |
| Field | Description |
|---|---|
evaluationErrorstring | EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or NonResourceRules may be incomplete. |
incompleteboolean | Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation. |
nonResourceRulesNonResourceRule array | NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. |
resourceRulesResourceRule array | ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1 | TokenRequest |
| Field | Description |
|---|---|
audiencestring | Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. |
expirationSecondsinteger | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec". |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | TokenRequest |
| Field | Description |
|---|---|
audiencestring | Audience is the intended audience of the token in "TokenRequestSpec". It will default to the audiences of kube apiserver. |
expirationSecondsinteger | ExpirationSeconds is the duration of validity of the token in "TokenRequestSpec". It has the same default value of "ExpirationSeconds" in "TokenRequestSpec" |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1beta1 | TokenReview |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | |
specTokenReviewSpec | Spec holds information about the request being evaluated |
statusTokenReviewStatus | Status is filled in by the server and indicates whether the request can be authenticated. |
| Field | Description |
|---|---|
audiencesstring array | Audiences is a list of the identifiers that the resource server presented with the token identifies as. Audience-aware token authenticators will verify that the token was intended for at least one of the audiences in this list. If no audiences are provided, the audience will default to the audience of the Kubernetes apiserver. |
tokenstring | Token is the opaque bearer token. |
| Field | Description |
|---|---|
audiencesstring array | Audiences are audience identifiers chosen by the authenticator that are compatible with both the TokenReview and token. An identifier is any identifier in the intersection of the TokenReviewSpec audiences and the token's audiences. A client of the TokenReview API that sets the spec.audiences field should validate that a compatible audience identifier is returned in the status.audiences field to ensure that the TokenReview server is audience aware. If a TokenReview returns an empty status.audience field where status.authenticated is "true", the token is valid against the audience of the Kubernetes API server. |
authenticatedboolean | Authenticated indicates that the token was associated with a known user. |
errorstring | Error indicates that the token couldn't be checked |
userUserInfo | User is the UserInfo associated with the provided token. |
create a TokenReview
POST /apis/authentication.k8s.io/v1beta1/tokenreviews
| Parameter | Description |
|---|---|
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
pretty | If 'true', then the output is pretty printed. |
| Parameter | Description |
|---|---|
bodyTokenReview |
| Code | Description |
|---|---|
| 200 TokenReview | OK |
| 201 TokenReview | Created |
| 202 TokenReview | Accepted |
| Group | Version | Kind |
|---|---|---|
authentication.k8s.io | v1beta1 | UserInfo |
| Field | Description |
|---|---|
extraobject | Any additional information provided by the authenticator. |
groupsstring array | The names of groups this user is a part of. |
uidstring | A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs. |
usernamestring | The name that uniquely identifies this user among all active users. |
| Group | Version | Kind |
|---|---|---|
flowcontrol.apiserver.k8s.io | v1alpha1 | UserSubject |
| Field | Description |
|---|---|
namestring | `name` is the username that matches, or "*" to match all usernames. Required. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | ValidatingWebhook |
| Field | Description |
|---|---|
admissionReviewVersionsstring array | AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`. |
clientConfigWebhookClientConfig | ClientConfig defines how to communicate with the hook. Required |
failurePolicystring | FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore. |
matchPolicystring | matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook. - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook. Defaults to "Exact" |
namestring | The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required. |
namespaceSelectorLabelSelector | NamespaceSelector decides whether to run the webhook on an object based on whether the namespace for that object matches the selector. If the object itself is a namespace, the matching is performed on object.metadata.labels. If the object is another cluster scoped resource, it never skips the webhook. For example, to run the webhook on any objects whose namespace is not associated with "runlevel" of "0" or "1"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "runlevel", "operator": "NotIn", "values": [ "0", "1" ] } ] } If instead you want to only run the webhook on any objects whose namespace is associated with the "environment" of "prod" or "staging"; you will set the selector as follows: "namespaceSelector": { "matchExpressions": [ { "key": "environment", "operator": "In", "values": [ "prod", "staging" ] } ] } See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels for more examples of label selectors. Default to the empty LabelSelector, which matches everything. |
objectSelectorLabelSelector | ObjectSelector decides whether to run the webhook based on if the object has matching labels. objectSelector is evaluated against both the oldObject and newObject that would be sent to the webhook, and is considered to match if either object matches the selector. A null object (oldObject in the case of create, or newObject in the case of delete) or an object that cannot have labels (like a DeploymentRollback or a PodProxyOptions object) is not considered to match. Use the object selector only if the webhook is opt-in, because end users may skip the admission webhook by setting the labels. Default to the empty LabelSelector, which matches everything. |
rulesRuleWithOperations array | Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects. |
sideEffectsstring | SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission change and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown. |
timeoutSecondsinteger | TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | ValidatingWebhookConfiguration |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata. |
webhooksValidatingWebhook array patch strategy: merge patch merge key: name | Webhooks is a list of webhooks and the affected resources and operations. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsValidatingWebhookConfiguration array | List of ValidatingWebhookConfiguration. |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
create a ValidatingWebhookConfiguration
POST /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
| 202 ValidatingWebhookConfiguration | Accepted |
partially update the specified ValidatingWebhookConfiguration
PATCH /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
replace the specified ValidatingWebhookConfiguration
PUT /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyValidatingWebhookConfiguration |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
| 201 ValidatingWebhookConfiguration | Created |
delete a ValidatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
| 202 Status | Accepted |
delete collection of ValidatingWebhookConfiguration
DELETE /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified ValidatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfiguration | OK |
list or watch objects of kind ValidatingWebhookConfiguration
GET /apis/admissionregistration.k8s.io/v1beta1/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 ValidatingWebhookConfigurationList | OK |
watch changes to an object of kind ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations/{name}
| Parameter | Description |
|---|---|
name | name of the ValidatingWebhookConfiguration |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of ValidatingWebhookConfiguration. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/admissionregistration.k8s.io/v1beta1/watch/validatingwebhookconfigurations
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
detachErrorVolumeError | The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a VolumeAttachment
POST /apis/storage.k8s.io/v1beta1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
| 202 VolumeAttachment | Accepted |
partially update the specified VolumeAttachment
PATCH /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
PUT /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
delete a VolumeAttachment
DELETE /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 202 VolumeAttachment | Accepted |
delete collection of VolumeAttachment
DELETE /apis/storage.k8s.io/v1beta1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
GET /apis/storage.k8s.io/v1beta1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
GET /apis/storage.k8s.io/v1beta1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1beta1/watch/volumeattachments
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeAttachment |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataObjectMeta | Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
specVolumeAttachmentSpec | Specification of the desired attach/detach volume behavior. Populated by the Kubernetes system. |
statusVolumeAttachmentStatus | Status of the VolumeAttachment request. Populated by the entity completing the attach or detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
attacherstring | Attacher indicates the name of the volume driver that MUST handle this request. This is the name returned by GetPluginName(). |
nodeNamestring | The node that the volume should be attached to. |
sourceVolumeAttachmentSource | Source represents the volume that should be attached. |
| Field | Description |
|---|---|
attachErrorVolumeError | The last error encountered during attach operation, if any. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachedboolean | Indicates the volume is successfully attached. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
attachmentMetadataobject | Upon successful attach, this field is populated with any information returned by the attach operation that must be passed into subsequent WaitForAttach or Mount calls. This field must only be set by the entity completing the attach operation, i.e. the external-attacher. |
detachErrorVolumeError | The last error encountered during detach operation, if any. This field must only be set by the entity completing the detach operation, i.e. the external-attacher. |
| Field | Description |
|---|---|
apiVersionstring | APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
itemsVolumeAttachment array | Items is the list of VolumeAttachments |
kindstring | Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
metadataListMeta | Standard list metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
create a VolumeAttachment
POST /apis/storage.k8s.io/v1alpha1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
| 202 VolumeAttachment | Accepted |
partially update the specified VolumeAttachment
PATCH /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch). |
force | Force is going to "force" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests. |
| Parameter | Description |
|---|---|
bodyPatch |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
replace the specified VolumeAttachment
PUT /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldManager | fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. |
| Parameter | Description |
|---|---|
bodyVolumeAttachment |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 201 VolumeAttachment | Created |
delete a VolumeAttachment
DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
| 202 VolumeAttachment | Accepted |
delete collection of VolumeAttachment
DELETE /apis/storage.k8s.io/v1alpha1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
dryRun | When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
gracePeriodSeconds | The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
orphanDependents | Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. |
propagationPolicy | Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
| Parameter | Description |
|---|---|
bodyDeleteOptions |
| Code | Description |
|---|---|
| 200 Status | OK |
read the specified VolumeAttachment
GET /apis/storage.k8s.io/v1alpha1/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. Deprecated. Planned for removal in 1.18. |
export | Should this value be exported. Export strips fields that a user can not specify. Deprecated. Planned for removal in 1.18. |
| Code | Description |
|---|---|
| 200 VolumeAttachment | OK |
list or watch objects of kind VolumeAttachment
GET /apis/storage.k8s.io/v1alpha1/volumeattachments
| Parameter | Description |
|---|---|
pretty | If 'true', then the output is pretty printed. |
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 VolumeAttachmentList | OK |
watch changes to an object of kind VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments/{name}
| Parameter | Description |
|---|---|
name | name of the VolumeAttachment |
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
watch individual changes to a list of VolumeAttachment. deprecated: use the 'watch' parameter with a list operation instead.
GET /apis/storage.k8s.io/v1alpha1/watch/volumeattachments
| Parameter | Description |
|---|---|
allowWatchBookmarks | allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored. |
continue | The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key". This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. |
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything. |
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything. |
limit | limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true. The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. |
pretty | If 'true', then the output is pretty printed. |
resourceVersion | resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
resourceVersionMatch | resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details. Defaults to unset |
timeoutSeconds | Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. |
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. |
| Code | Description |
|---|---|
| 200 WatchEvent | OK |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeAttachmentSource |
| Field | Description |
|---|---|
inlineVolumeSpecPersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. |
persistentVolumeNamestring | Name of the persistent volume to attach. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeAttachmentSource |
| Field | Description |
|---|---|
inlineVolumeSpecPersistentVolumeSpec | inlineVolumeSpec contains all the information necessary to attach a persistent volume defined by a pod's inline VolumeSource. This field is populated only for the CSIMigration feature. It contains translated fields from a pod's inline VolumeSource to a PersistentVolumeSpec. This field is alpha-level and is only honored by servers that enabled the CSIMigration feature. |
persistentVolumeNamestring | Name of the persistent volume to attach. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeError |
| Field | Description |
|---|---|
messagestring | String detailing the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information. |
timeTime | Time the error was encountered. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1alpha1 | VolumeError |
| Field | Description |
|---|---|
messagestring | String detailing the error encountered during Attach or Detach operation. This string maybe logged, so it should not contain sensitive information. |
timeTime | Time the error was encountered. |
| Group | Version | Kind |
|---|---|---|
storage.k8s.io | v1beta1 | VolumeNodeResources |
| Field | Description |
|---|---|
countinteger | Maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not twice. The same rule applies for a unique volume that is shared among multiple pods on the same node. If this field is nil, then the supported number of volumes on this node is unbounded. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1 | WebhookClientConfig |
| Field | Description |
|---|---|
caBundlestring | caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use `service`. |
urlstring | url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |
| Group | Version | Kind |
|---|---|---|
admissionregistration.k8s.io | v1beta1 | WebhookClientConfig |
| Field | Description |
|---|---|
caBundlestring | `caBundle` is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | `service` is a reference to the service for this webhook. Either `service` or `url` must be specified. If the webhook is running within the cluster, then you should use `service`. |
urlstring | `url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |
| Group | Version | Kind |
|---|---|---|
apiextensions.k8s.io | v1beta1 | WebhookClientConfig |
| Field | Description |
|---|---|
caBundlestring | caBundle is a PEM encoded CA bundle which will be used to validate the webhook's server certificate. If unspecified, system trust roots on the apiserver are used. |
serviceServiceReference | service is a reference to the service for this webhook. Either service or url must be specified. If the webhook is running within the cluster, then you should use `service`. |
urlstring | url gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be "https"; the URL must begin with "https://". A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. "user:password@" is not allowed. Fragments ("#...") and query parameters ("?...") are not allowed, either. |